optioning 0.0.1.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc150f3f4fa42753cb3c1011ad5b600ee99161ba
+  data.tar.gz: 81fab4b72bd887253736ef73fb4f410c46b70bac
+SHA512:
+  metadata.gz: e1755b2e41aa8dd4cb98a9aa04603e9c0670722954ccb711ef6480317ba8d4a070cf30cb01587239a98d99ee8279c4ce670db7ea2bb46a46cc305c3112312c1b
+  data.tar.gz: c1072d7a3dd4b834ef7587027f9afc3da134998b5feaa0eae7f3a1da4436dded1b2add9edc2130e71847ce392af650668c39415d947dab658aaddb5ca9733d63

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+script: 'bundle exec rake'
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in optioning.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ricardo Valeriano
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,227 @@
+# Optioning
+
+An easy way to retrieve, store, filter, transform and deprecate `options` passed
+to a method. Where `options` are the keys our beloved `Hash` as last parameter
+for a method call.
+
+## Status
+[![Gem Version](https://badge.fury.io/rb/optioning.svg)](http://badge.fury.io/rb/hashing)
+[![Build Status](https://travis-ci.org/ricardovaleriano/optioning.svg?branch=master)](http://travis-ci.org/ricardovaleriano/hashing?branch=master)
+[![Code Climate](https://codeclimate.com/github/ricardovaleriano/optioning.png)](https://codeclimate.com/github/ricardovaleriano/hashing)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'optioning'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install optioning
+
+## Contact
+
+* API Doc: http://rdoc.info/gems/optioning
+* Bugs, issues and feature requests: https://github.com/ricardovaleriano/optioning/issues
+* Support: http://stackoverflow.com/questions/tagged/optioning-ruby
+
+## Usage
+
+Given the following `File` class:
+
+```ruby
+class File
+  def initialize(path, commit = nil, content = nil)
+    @path, @commit, @content = path, commit, content
+  end
+end
+```
+
+And a module called `Hashing`, which defines a method `.serialize` that allow
+you configure which `ivars` should be used to convert instances of `File` into a
+`Hash` like this:
+
+```ruby
+{
+  path: @path,
+  commit: @commit,
+  content: @content
+}
+```
+
+And I can configure a transformation in the values of `path`, `commit` and
+`content` when transforming it into a `Hash` like so:
+
+```ruby
+require 'hashing'
+
+class File
+  extend Hashing
+
+  hasherize :path, :commit, to_hash: ->(value) { value.downcase }
+end
+```
+
+As the implementor of this module and the `.hasherize` method, I want to be able
+to use an instance of `Optioning`, so I can store and retrieve the `ivars` and
+the `options` passed to be used along those `ivars`:
+
+```ruby
+module Hashing
+  def hasherize(*ivars_and_options)
+    @options = Optioning.new ivars_and_options
+
+    # ...
+  end
+end
+```
+
+Now in the `Optioning` instance, I can call the following (among others)
+methods:
+
+```ruby
+@options.raw
+# => [:path, :commit, {to_hash: #<Proc:0x007fa4120bd318@(irb):1 (lambda)>}]
+
+@options.values
+# => [:path, :commit]
+
+@options.on :to_hash
+# => #<Proc:0x007fa4120bd318@(irb):1 (lambda)>
+```
+
+### Deprecating options
+
+Now, following our example, if you need to deprecat the `:to_hash` option in
+favor of the new `:to` option, you could do:
+
+```ruby
+def hasherize(*ivars_and_options)
+  @options = Optioning.new ivars_and_options
+  @options.deprecate :to_hash, :to, Date.new(2015, 05, 01)
+
+  # ...
+end
+```
+
+This will replace the deprecated option `:to_hash` for the new one named `:to`
+so you can do the following invocation to recover the value passed to the
+deprecated `option`:
+
+```ruby
+@options.on :to_hash
+
+# => #<Proc:0x007fa4120bd318@(irb):1 (lambda)>
+```
+
+#### Deprecation warnings
+
+You can alert your user about those deprecations using the `#deprecated_warn`
+method:
+
+```ruby
+def hasherize(*ivars_and_options)
+  @options = Optioning.new ivars_and_options
+  @options.deprecate :to_hash, :to
+  @options.deprecated_warn
+
+  # ...
+end
+```
+
+You can inform the date when the deprecation will not be available anymore.
+These date will be parte of the deprecation message:
+
+```ruby
+@options.deprecate :to_hash, :to, Date.new(2015, 05, 01)
+```
+
+Or if you prefer, you can specify a version of your software that pretend to
+remove the deprecated thing:
+
+```ruby
+@options.deprecate :to_hash, :to, "v2.0.0"
+```
+
+### Ignoring unrecongnized options
+
+If you need, you could fitler the options to mantain just the recognized ones
+available. To configure the options that matters to your program, use the method
+`#recognize`. And to warn the user in case a unrecognized option is used, call
+the `#unrecognized_warn` method:
+
+```ruby
+def hasherize(*ivars_and_options)
+  @options = Optioning.new ivars_and_options
+  @options.recognize :to_hash
+  @options.unrecognized_warn
+
+  # ...
+end
+```
+
+Now, if a user pass an option different than the `:to_hash` one, a warning will
+inform that the option is not recognized and will be ignored.
+
+#### Do I Need to register deprecated options as recognized?
+
+Fortunatelly no. You just need to register your deprecations as usual:
+
+```ruby
+def hasherize(*ivars_and_options)
+  @options = Optioning.new ivars_and_options
+  @options.recognize :from
+  @options.deprecate :to_hash, :to
+  @options.deprecated_warn
+  @options.unrecognized_warn
+
+  # ...
+end
+```
+
+The `#deprecate` method already knows what to do (that is register the `option`
+`:to_hash` as recognized. To sum up, in this last example, the options `:from`
+and `:to` are already recongnized by the `Optioning` instance.
+
+### `#process`
+
+The `#process` method will replace all deprecations, warn about them and warn
+about unrecognized options all at once, so you can use it like this:
+
+```ruby
+def hasherize(*ivars_and_options)
+  @options = Optioning.new ivars_and_options
+  @options.recognize :from
+  @options.deprecate :to_hash, :to
+  @options.process
+
+  # ...
+end
+```
+
+### Fluent interface
+
+And finally, just for a matter of taste, `#deprecate`, `#recognize` and
+`#process` returns the `Optioning` instance itself, so you can write the last
+example like this (if you want)
+
+```ruby
+def hasherize(*ivars_and_options)
+  @options = Optioning.new(ivars_and_options).recognize(:from)
+  @options.deprecate(:to_hash, :to).process
+
+  # ...
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/optioning/fork )
+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,4 @@
+require "bundler/gem_tasks"
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |rake| load rake }
+task default: "test"

data/lib/optioning/version.rb

@@ -0,0 +1,3 @@
+module Optioning
+  VERSION = "0.0.1.beta"
+end

data/lib/optioning.rb

@@ -0,0 +1,5 @@
+require "optioning/version"
+
+module Optioning
+  # Your code goes here...
+end

data/optioning.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'optioning/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "optioning"
+  spec.version       = Optioning::VERSION
+  spec.authors       = ["Ricardo Valeriano"]
+  spec.email         = ["ricardo.valeriano@gmail.com"]
+  spec.summary       = %q{An object oriented way to treat our beloved last parameter: Hash.}
+  spec.description   = %q{An easy way to retrieve, store, filter and deprecate `options` passed to a method. Where `options` are the keys on our beloved `Hash` as last parameter for a method call.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-reporters", "~> 1.0"
+end

data/tasks/lines.rake

@@ -0,0 +1,8 @@
+desc 'line number statistics'
+task :lines do
+  libdir = File.join File.dirname(__FILE__), 'lib'
+  Dir["lib/**/*.rb"].each { |file|
+    lines = File.readlines(file).reject { |line| line =~ /^(\s*)#/ }.count
+    puts "#{lines.to_s.rjust(3)} in #{file}"
+  }
+end

data/tasks/test.rake

@@ -0,0 +1,26 @@
+desc "run all tests"
+
+args = ARGV
+args.shift
+files = args
+
+desc "run all the tests"
+
+task :test do
+  lib = File.expand_path("../lib", __FILE__)
+  $: << lib
+
+  loader = ->(files_list){
+    files_list.each do |f|
+      if File.directory?(f)
+        loader.call(Dir.glob(f + "/**/*_test.rb"))
+      else
+        load f
+      end
+    end
+  }
+
+  require_relative "../test/test_helper"
+  files = Dir.glob("test/**/*_test.rb") unless files.size > 0
+  loader.call(files)
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "minitest/autorun"
+require "minitest/reporters"
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+require_relative "../lib/optioning"

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: optioning
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta
+platform: ruby
+authors:
+- Ricardo Valeriano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: An easy way to retrieve, store, filter and deprecate `options` passed
+  to a method. Where `options` are the keys on our beloved `Hash` as last parameter
+  for a method call.
+email:
+- ricardo.valeriano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/optioning.rb
+- lib/optioning/version.rb
+- optioning.gemspec
+- tasks/lines.rake
+- tasks/test.rake
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: 'An object oriented way to treat our beloved last parameter: Hash.'
+test_files:
+- test/test_helper.rb