broilerplate 0.0.0

data/.gitignore

@@ -0,0 +1,9 @@
+.project
+.bundle
+.rvmrc
+Gemfile.lock
+pkg/
+*.rbc
+.yardoc/
+doc/
+coverage/

data/.rspec

@@ -0,0 +1,3 @@
+--order rand
+--color
+--format Fuubar

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby
+  - rbx
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true
+script: bundle exec rake -t metrics:coverage ci

data/.yardopts

@@ -0,0 +1,2 @@
+- UNLICENSE
+- examples/*

data/Gemfile

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
+gem 'fuubar',   git: 'https://github.com/lgierth/fuubar.git',
+                ref: 'static-percentage'
+
+gem 'awesome_print'
+gem 'pry'
+gem 'rbtrace'
+
+platform :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius', '~> 2.0'
+end
+
+# Added by devtools
+eval_gemfile 'Gemfile.devtools'

data/Gemfile.devtools

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',  '~> 10.1.0'
+  gem 'rspec', '~> 2.14.1'
+  gem 'yard',  '~> 0.8.7'
+
+  platform :rbx do
+    gem 'rubysl-singleton', '~> 2.0.0'
+  end
+end
+
+group :yard do
+  gem 'kramdown', '~> 1.3.0'
+end
+
+group :guard do
+  gem 'guard',         '~> 2.2.4'
+  gem 'guard-bundler', '~> 2.0.0'
+  gem 'guard-rspec',   '~> 4.2.0'
+  gem 'guard-rubocop', '~> 1.0.0'
+
+  # file system change event handling
+  gem 'listen',     '~> 2.4.0'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.3', require: false
+  gem 'rb-inotify', '~> 0.9.0', require: false
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.0', require: false
+  gem 'rb-notifu',               '~> 0.0.4', require: false
+  gem 'terminal-notifier-guard', '~> 1.5.3', require: false
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.7.0'
+  gem 'flay',      '~> 2.4.0'
+  gem 'flog',      '~> 4.2.0'
+  gem 'reek',      '~> 1.3.2'
+  gem 'rubocop',   '~> 0.16.0'
+  gem 'simplecov', '~> 0.8.2'
+  gem 'yardstick', '~> 0.9.7', git: 'https://github.com/dkubb/yardstick.git'
+
+  platforms :ruby_19, :ruby_20 do
+    gem 'mutant',          '~> 0.3.0', git: 'https://github.com/mbj/mutant.git'
+    gem 'unparser',        '~> 0.1.5',
+        git: 'https://github.com/mbj/unparser.git'
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platform :rbx do
+    gem 'json',               '~> 1.8.1'
+    gem 'racc',               '~> 1.4.10'
+    gem 'rubysl-logger',      '~> 2.0.0'
+    gem 'rubysl-open-uri',    '~> 2.0.0'
+    gem 'rubysl-prettyprint', '~> 2.0.2'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.5'
+  end
+end

data/README.md

@@ -0,0 +1,36 @@
+# broilerplate [![Build Status](https://travis-ci.org/lgierth/broilerplate.png?branch=master)](https://travis-ci.org/lgierth/broilerplate) [![Code Climate](https://codeclimate.com/github/lgierth/broilerplate.png)](https://codeclimate.com/github/lgierth/broilerplate) [![Coverage Status](https://coveralls.io/repos/lgierth/broilerplate/badge.png?branch=master)](https://coveralls.io/r/lgierth/broilerplate?branch=master)
+
+If this isn't the repository "broilerplate", chances are the authors of this
+repository didn't add a proper README yet and left the boilerplate (me) here.
+
+My personal broilerplate for Ruby libraries. Fork and code ahead.
+
+## Usage
+
+Fork and clone, then execute:
+
+    $ bundle
+
+To verify that everything works, run the CI task, and the included example.
+
+    $ bundle exec rake ci
+    $ bundle exec ruby examples/getting_started.rb
+
+Now replace all occurences of `[Bb]roilerplate` with your library's name.
+Also replace the metadata in the gemspec.
+
+You also want to enable the Travis and Rdocinfo hooks for your GitHub repository.
+
+## Unlicense
+
+broilerplate is free and unencumbered public domain software. For more
+information, see [unlicense.org](http://unlicense.org/) or the accompanying
+UNLICENSE file.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+# Added by devtools
+require 'devtools'
+Devtools.init_rake_tasks

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/broilerplate.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'broilerplate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'broilerplate'
+  spec.version       = Broilerplate::VERSION
+  spec.authors       = ['Lars Gierth']
+  spec.email         = ['larsg@systemli.org']
+  spec.description   = %q{My personal Ruby boilerplate}
+  spec.summary       = %q{My personal boilerplate for Ruby libraries. Fork and code ahead.}
+  spec.homepage      = 'https://github.com/lgierth/boilerplate'
+  spec.license       = 'Public Domain'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+  spec.executables   = spec.files.grep(%r{^bin/})
+
+  spec.add_development_dependency 'rspec'
+end

data/config/devtools.yml

@@ -0,0 +1,4 @@
+---
+unit_test_timeout: 0.1
+fail_on_branch:
+- "master"

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 0
+total_score: 0

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 10

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: broilerplate
+namespace: Broilerplate

data/config/reek.yml

@@ -0,0 +1,103 @@
+---
+Attribute:
+  enabled: true
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 2
+  overrides:
+    initialize:
+      max_params: 3
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 2
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 3
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 10
+TooManyStatements:
+  enabled: true
+  exclude:
+  - each
+  max_statements: 2
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 0

data/config/rubocop.yml

@@ -0,0 +1,57 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.devtools'
+  Excludes:
+    - '**/vendor/**'
+    - '**/benchmarks/**'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Limit line length
+LineLength:
+  Max: 79
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false
+
+# Allow empty lines around body
+EmptyLinesAroundBody:
+  Enabled: false
+
+SignalException:
+  # Valid values are: semantic, only_raise and only_fail
+  EnforcedStyle: only_raise

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/examples/getting_started.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'broilerplate'
+
+puts sprintf('broilerplate version %s', Broilerplate::VERSION)

data/lib/broilerplate.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'broilerplate/version'

data/lib/broilerplate/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Broilerplate
+  VERSION = '0.0.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec:unit'
+
+    add_filter 'config'
+    add_filter 'spec'
+  end
+end
+
+require 'broilerplate'
+
+require 'awesome_print'
+require 'pry'
+
+require 'devtools/spec_helper'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: broilerplate
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Lars Gierth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: My personal Ruby boilerplate
+email:
+- larsg@systemli.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- Gemfile
+- Gemfile.devtools
+- README.md
+- Rakefile
+- UNLICENSE
+- broilerplate.gemspec
+- config/devtools.yml
+- config/flay.yml
+- config/flog.yml
+- config/mutant.yml
+- config/reek.yml
+- config/rubocop.yml
+- config/yardstick.yml
+- examples/getting_started.rb
+- lib/broilerplate.rb
+- lib/broilerplate/version.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lgierth/boilerplate
+licenses:
+- Public Domain
+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: My personal boilerplate for Ruby libraries. Fork and code ahead.
+test_files:
+- spec/spec_helper.rb
+has_rdoc: