Commit Graph

331 Commits

Author SHA1 Message Date
Will Hopper a44ec44708 Merge pull request #102 from peterhuene/spec-fixes
(PDOC-63) Restore acceptance test to the spec directory.
2016-09-16 15:45:58 -07:00
Peter Huene e5577e199c
(PDOC-63) Restore acceptance test to the spec directory.
Previously the acceptance test was implemented under the `spec` directory and
was moved out to a top level `acceptance` directory.

This broke the expected location for the node configuration files.

This commit puts the acceptance test back where it was previously.

Also fixes a failure in the test now that Markdown is the default markup
language used.
2016-09-16 15:42:00 -07:00
Jesse Scott 0b682d5710 Merge pull request #101 from whopper/maint/gem_source
(maint) Make GEM_SOURCE configurable in Gemfile
2016-09-16 15:19:03 -07:00
Will Hopper 98a14685f4 (maint) Make GEM_SOURCE configurable in Gemfile 2016-09-16 15:15:17 -07:00
Will Hopper ee0cc0e5a4 Merge pull request #100 from peterhuene/spec-fixes
(PDOC-63) Fix specs for Puppet versions less than 4.1.
2016-09-16 13:08:33 -07:00
Peter Huene 9ba9b56306
(PDOC-63) Fix specs for Puppet versions less than 4.1.
The specs test functions written in the Puppet language in a few places, but
this feature is only supported in Puppet 4.1+.  This commit prevents these
specs from running if targeting older versions of Puppet.
2016-09-16 12:16:35 -07:00
Will Hopper ef651fb33a Merge pull request #99 from peterhuene/readme
(maint) Minor fixes to README.
2016-09-16 10:38:10 -07:00
Peter Huene e396000f3d
(maint) Minor fixes to README.
Some minor fixes to the README that need correction following the recent
refactoring commit.
2016-09-16 10:32:43 -07:00
Will Hopper 7ae8e74ec5 Merge pull request #98 from peterhuene/rewrite
(PDOC-63) Code refactoring, fix up, and lots of new functionality.
2016-09-16 09:57:10 -07:00
Peter Huene 01913fcfb0
(PDOC-63) Update README and JSON files.
This commit updates the README and JSON documentation files to make them
consistent with the refactoring work.
2016-09-15 17:15:54 -07:00
Peter Huene 7897c70a52
(maint) RuboCop fixes.
This commit fixes a few RuboCop related failures.
2016-09-15 17:15:54 -07:00
Peter Huene cf77ef1379
(PDOC-63) Add specs to test the new implementation.
This commit adds specs to cover parts of the new implementation of Puppet
Strings.
2016-09-15 17:15:54 -07:00
Peter Huene f2aa7d00c5
(PDOC-63) Implement the Puppet Strings rake tasks.
This commit implements the `strings:generate` and `strings:gh_pages:update`
rake tasks.

The `strings:generate` task is responsible for generating Puppet Strings
documentation.

The `strings:gh_pages:update` task is responsible for updating the `gh_pages`
branch of a GitHub repository with the latest Puppet Strings documentation.
2016-09-15 17:15:53 -07:00
Peter Huene 1be391ee87
(PDOC-63) Implement JSON output.
This commit implements the JSON output for Puppet strings.
2016-09-15 17:15:50 -07:00
Peter Huene f025efe557
(PDOC-63) Implement a Puppet function YARD handler.
This commit implements a YARD handler for Puppet functions and the
associated code object and templates.
2016-09-15 13:55:00 -07:00
Peter Huene b1a15bd43a
(PDOC-63) Implement a Puppet provider YARD handler.
This commit implements a YARD handler for Puppet providers and the
associated code object and templates.
2016-09-15 13:54:55 -07:00
Peter Huene 22396a13d0
(PDOC-63) Implement a Puppet resource type YARD handler.
This commit implements a YARD handler for Puppet resource types and the
associated code object and templates.
2016-09-15 13:54:50 -07:00
Peter Huene 187dec9cee
(PDOC-63) Implement a Puppet defined type YARD handler.
This commit implements a YARD handler for Puppet defined types and the
associated code object and templates.
2016-09-15 13:54:45 -07:00
Peter Huene 7c3cd5463c
(PDOC-63) Implement a Puppet class YARD handler.
This commit implements a YARD handler for Puppet classes and the associated
code object and templates.
2016-09-15 13:54:37 -07:00
Peter Huene f2e41a9c23
(PDOC-63) Implement the Puppet parser.
This commit implements the Puppet language parser that future handlers will use
to generate YARD code objects for classes, defined types, and functions written
in Puppet.
2016-09-15 13:54:32 -07:00
Peter Huene d4bab8a5ab
(PDOC-63) Add initial YARD configuration.
This commit adds the initial YARD configuration.  Subsequent commits will
integrate the code objects, handlers, parsers, tags, and templates to support
Puppet code.
2016-09-15 13:54:27 -07:00
Peter Huene ea9dd0c846
(PDOC-63) Delete the old implementation.
This commit deletes the old implementation to assist in cleaner code reviews of
the upcoming reimplementation.

This commit also moves YARD to version 0.9.5 and lays down a bare bones
implementation of Puppet Strings that currently does nothing.
2016-09-15 13:54:18 -07:00
Peter Huene 56f266db4b
(maint) Rename puppetlab-strings to puppet-strings where appropriate.
This commit changes the source and documentation to reference this project as
`puppet-strings` rather than `puppetlabs-strings`.

This makes the source and project match the gem name.
2016-09-14 13:42:28 -07:00
Peter Huene 33788ce247
(maint) Update gitignore to ignore RubyMine and rvm/rbenv files.
Adding `.idea/` and `.ruby-version` to gitignore.

Also adding `doc/` for YARD output.

Excluding VIM tags only in the root.
2016-09-14 13:42:28 -07:00
Peter Huene b7472d5043 Merge pull request #97 from kylog/pin-rubocop
(maint) Pin rubocop to enable spec support for ruby < 2.0
2016-09-01 16:08:18 -07:00
Kylo Ginsberg a9e55c7e60 (maint) Enable rubocop tests to pass again
* Pin rubocop to enable spec support for ruby < 2.0
* Add 'Enabled: false' for a number of new rubocop tests.
2016-09-01 12:53:24 -07:00
Henrik Lindberg 138dc25a7b Merge pull request #90 from baltimore-puppet-users-group/PDOC-71
(PDOC-71) Workaround for spurious error failures
2016-07-18 13:14:29 +02:00
Trevor Vaughan e39b4f3533 (PDOC-71) Workaround for spurious error failures
This patch catches and reports on issues that have occurred during YARD
processing of the data to be processed.

The issue itself is not resolved but this does provide you with as much
documentation as can be reasonably generated for your materials without
crashing the build.

This was the result of the Baltimore Puppet Users Group Meetup of 22
June 2016.
2016-07-18 07:03:15 -04:00
Hailee Kenney 57a3bffc47 Merge pull request #81 from danzilio/tasks
Adding tasks to automate building GitHub pages from strings docs
2016-07-13 10:18:08 +01:00
Will Hopper 554cb92d77 Merge pull request #91 from HAIL9000/maint/master/tie_strings_to_yard_version
(maint) Tie YARD to version 0.8.7
2016-07-12 12:50:22 -07:00
Hailee Kenney a6e145d20c (maint) Tie YARD to version 0.8.7
Prior to this commit, we were not setting a specific version of
YARD in the Gemfile. Since YARD has a lot of potential to break the
way strings works since strings relies so much on YARD internals,
we should be more deliberate about deciding to upgrade to a new
YARD version.

Once the kinks are worked out with the 0.9 release of YARD, we will
update the Gemfile again.
2016-07-12 19:25:57 +01:00
David Danzilio aac3dd08b0 Adding documentation for the gh_pages task 2016-07-05 15:52:06 -04:00
David Danzilio 825614067a Handling existing doc directory 2016-07-05 15:52:06 -04:00
David Danzilio 84e6ade587 Adding GitHub Pages tasks 2016-07-05 15:52:06 -04:00
Hailee Kenney b39409ae79 Merge pull request #89 from smcelmurry/qeng-3888
(QENG-3888) Remove static nodeset, use beaker-hostgenerator
2016-06-21 11:26:27 -07:00
Spencer McElmurry c6de41e6b9 (QENG-3888) Remove static nodeset, use beaker-hostgenerator
This is additional work for QENG-3888 in ci-job-configs. We were using static
nodesets within specs/acceptance/nodesets before and this commit will instead use beaker-hostgenerator
to get the specified platform .yml configurations.
2016-06-20 14:13:41 -07:00
Henrik Lindberg eaee88b8f8 Merge pull request #86 from vStone/feature/configurable_rake_task
PDOC-77: configurable rake task
2016-06-14 21:37:50 +02:00
Hailee Kenney aa3682e3a6 Merge pull request #87 from domcleal/pdoc-78-gemspec-license
(PDOC-78) Include LICENSE, docs and specs in gem
2016-05-18 16:09:07 -07:00
Kylo Ginsberg 8c232fba7e Merge pull request #88 from HAIL9000/maint/master/fix_acceptance_test
(maint) Update hostfile for acceptance test
2016-05-11 17:10:55 -07:00
Hailee Kenney a6e5a806be (maint) Update hostfile for acceptance test
Prior to this commit, strings had a hostfile that was using an old
format that is no longer compatible with beaker which was causing
the acceptance tests to fail.

Update the hostfile so that it works.
2016-05-11 16:05:02 -07:00
Jan Vansteenkiste 4b71a0ce72 PDOC-77: Updated the documentation to include the new rake task 2016-05-09 08:38:06 +02:00
Jan Vansteenkiste 9f349dca9e PDOC-77: Add a new rake task which can be configured 2016-05-06 11:54:36 +02:00
Dominic Cleal caba623d2c
(PDOC-78) Include LICENSE, docs and specs in gem 2016-05-05 09:44:41 +01:00
Will Hopper 2fa33621d5 Merge pull request #85 from HAIL9000/maint/master/fix_acceptance_test
(maint) Update acceptance tests to use gem
2016-05-02 16:41:27 -07:00
Hailee Kenney b8a23d3617 (maint) Update acceptance tests to use gem
Prior to this commit, the acceptance tests were trying to install
strings as a module and failing due to the fact that strings has
transition to a gem and does not have metadata. Update the tests
so that they install strings as a gem instead.
2016-05-02 15:00:38 -07:00
Hailee Kenney e36d8affe6 Merge pull request #84 from hggh/fix/doc/README
(doc) fix link to CONTRIBUTING / fix --emit-json option
2016-05-02 14:38:16 -07:00
Jonas Genannt 14631d81f9 (doc) fix link to CONTRIBUTING / fix --emit-json option
link to CONTRIBUTING was wrong.

example for json output has a missing yardoc option
2016-04-28 11:11:08 +02:00
Kylo Ginsberg f7cd0dabb0 Merge pull request #83 from HAIL9000/maint/master/require_rspec_3
(maint) Require rspec 3
2016-04-25 21:20:36 -07:00
Hailee Kenney 73518f9d41 (maint) Require rspec 3
Prior to this commit, the Gemfile did not specify an rspec version
but relied on methods that were only in rspec 3. In order to prevent
failures when running with versions older than 3, tie the specs to
3.1 or greater, which is what puppet does.
2016-04-25 16:45:52 -07:00
Kylo Ginsberg 7e3470f7cf Merge pull request #82 from HAIL9000/maint/master/remove_module_related_content
(maint) Remove module related content
2016-04-22 15:39:16 -07:00