devutils-docs 0.0.1

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2012, Stefan Radomski
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the devutils nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL Stefan Radomski BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,73 @@
+devutils
+========
+
+These are small tools to make development easier in that they provide metagems
+which pulls other common gems for development purposes.
+
+usage
+-----
+
+To use devutils, first install the gem with
+
+    $ gem install devutils
+
+Now that it is available, you can use it to create new projects
+
+    $ devutils init foo
+
+This will create a directory structure in foo with a Gemfile already placed.
+That Gemfile will hold 4 gems, which will pull in other dependencies most need
+for development. If you don't want a dependency or want to use another one, you
+are free to, as devutils will never again touch any files.
+
+You can modify the behaviour with the following flags
+
+* --metrics/--no-metrics:
+  install tools for meassuring code quality (default: true)
+* --docs/--no-docs:
+  installs yard for documentation (default: true)
+* --guard/--no-guard:
+  installs rudimentary guard support (default: true)
+
+dependencies
+------------
+
+The dependencies of the gems are as follows
+
+### devutils
+
+* [rspec][rspec]: for writing specs
+
+### devutils-docs
+
+* [yard][yard]: to parse documentation into html files
+
+### devutils-metrics
+
+* [reek][reek]: a tool for code smell detection
+* [flog][flog]: creates pain reports of the code
+* [flay][flay]: finds duplicated code
+* [roodi][roodi]: an object oriented code infometer
+* [mutant][mutant]: a mutation testing tool
+* [simplecov][simplecov]: a test coverage reporting tool (needs ruby > 1.8)
+* [pelusa][pelusa]: a code analytics tool (needs rubinius)
+
+### devutils-guard
+
+* [guard][guard]:
+  a tool to run automatic tasks on file changes (makes testing nicer)
+* [guard-rspec][guard-rspec]: runs your specs automatically
+* [guard-bundler][guard-bundler]: runs bundler, when your Gemfile changes
+
+[yard]: http://yardoc.org/
+[reek]: https://github.com/troessner/reek/wiki
+[flog]: https://github.com/seattlerb/flog
+[flay]: https://github.com/seattlerb/flay
+[rspec]: http://rspec.info/
+[roodi]: https://github.com/martinjandrews/roodi
+[guard]: https://github.com/guard/guard
+[mutant]: https://github.com/mbj/mutant
+[pelusa]: http://codegram.github.com/pelusa/
+[simplecov]: https://github.com/colszowka/simplecov
+[guard-rspec]: https://github.com/guard/guard-rspec
+[guard-bundler]: https://github.com/guard/guard-bundler

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: devutils-docs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stefan Radomski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A dependency for devutils, which mangages documentation.
+email: gibheer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+homepage: https://github.com/gibheer/devutils
+licenses:
+- 3-clause BSD
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A dependency for devutils, which mangages documentation.
+test_files: []