optioning 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb571b317a86bb694b31fe6855625a4ba1c09b60
-  data.tar.gz: 1ed0d7f6e2b6f00408cb822c9646cafa7a380289
+  metadata.gz: 451aa0a9196e26ac26df53e01c3612d5235aa515
+  data.tar.gz: 6d98daa29a5b3341ed2c37346b6a967a2181913e
 SHA512:
-  metadata.gz: 779901e1f14d001f9b8bb86ad71ff0220a0e828314a56f203dd111f41ff73cf87bd49a904114fc218863749ccfa6519a8b811bfeb74147f0ceb60ec09b33ee21
-  data.tar.gz: 7d38b65431ad13a11ce86ab25bdb973e6d7549bd2ecfc6e99a026235dc35b5e3b59544a0593e0adf497035f6baa64dee630f4a81486f2289e575401e6265c30b
+  metadata.gz: a8b0c47ffdcbb48f64ded9aef1a970133238bb26e887d7030b7fafeb59fe4e080c59fef1cc4666d1a1b05227b85468c6f7332e6c75ed61cb467cc7af9bad2c00
+  data.tar.gz: 5092720e34d3975d2584b8f9e0de705ab813211b2f648e8837d4e58b44c5085a6497f07d8b9c92ef88b168dd214014fa07fcfd9c1c26f7c1729fabb597d14472

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.1.0 2014-05-23
+
+## first (announced) public release
+
+  - Adds a more direct an simple main usage example
+
 # v0.0.3 2014-05-13
 
 ## first public release :heartpulse:

data/README.md

@@ -34,49 +34,71 @@ Or install it yourself as:
 
 ### An "end to end" example
 
-Given a `Hashing` module, with a `.hasherize` method like this:
+Given the following class:
 
 ```ruby
-module Hashing
+require 'optioning'
+
+class FileExample
+  def initialize(path, commit, content)
+    @content = content
+    @path, @commit = path, commit
+  end
+
+  def export
+    hasherize :path, :commit,
+      to_hash: ->(){},
+      store: "NO!",
+      persist: "I will persist!"
+  end
+
+  private
+
   def hasherize(*values_and_options)
-    optioning = Optioning.new values_and_options
-    optioning.deprecate :to_hash, :to, "v2.0.0"
-    optioning.recognize :persist
-    optioning.process caller
-
-    puts "*" * 80
-    puts optioning.on :to
-    puts optioning.on :persist
+    # ...
   end
 end
 ```
 
-And a `class` `Client` extending the `Hashing` and invoking the `.hasherize`
-method like in this example:
+And the following implementation of the private method `#hasherize`, which uses
+`Optioning` to retrieve the arguments and options passed to it:
 
 ```ruby
-require "./hashing"
-class Client
-  extend Hashing
+optioning = Optioning.new values_and_options
+optioning.deprecate :to_hash, :to, "v2.0.0"
+optioning.recognize :persist
+optioning.process caller
+
+puts "\n#{'*'* 80}"
+puts "I should export the follow ivars: #{optioning.values}"
+puts optioning.on :to
+puts optioning.on :persist
+puts optioning.on :store
+```
 
-  hasherize :some_ivar, to_hash: ->(){}, store: "NO!", persist: "I will persist!"
-end
+If you call the `#export` method in an instance of `FileExample` like this:
+
+```ruby
+file = FileExample.new('/some/file.rb', 'cfe9aacbc02528b', '#omg! such file!')
+file.export
 ```
 
-The following output will be generated:
+The result will be:
 
 ```
 NOTE: option `:to_hash` is deprecated; use `:to` instead. It will be removed on or after version v2.0.0.
-Called from examples/client_maroto.rb:5:in `<class:Client>'.
+Called from examples/file.rb:15:in `export'.
 NOTE: unrecognized option `:store` used.
 You should use only the following: `:to`, `:persist`
-Called from examples/client_maroto.rb:5:in `<class:Client>'.
+Called from examples/file.rb:15:in `export'.
 ********************************************************************************
-#<Proc:0x007fd6f42749a8@examples/client_maroto.rb:5 (lambda)>
+I should export the follow ivars: [:path, :commit]
+#<Proc:0x007fa9658631a0@examples/file.rb:16 (lambda)>
 I will persist!
+NO!
 ```
 
-The warning messages will be written in the `$stderr`. Done! :smiley:
+To play with this example go to the file `examples\file.rb` in this project.
 
 ### A more step by step example
 
@@ -231,11 +253,10 @@ warning will be exhibited.
  * [ ] maybe we should allow a deprecation strategy? To choose between warning
    or exception when a deprecated options is called?
 
-### Ignoring unrecongnized options
+### 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
+To configure the options that matters to your program, use the method
+`#recognize`. And to warn the user in case an unrecognized option is used, call
 the `#unrecognized_warn` method:
 
 ```ruby
@@ -249,7 +270,7 @@ end
 ```
 
 Now, if a user pass an option different than the `:from` one, a warning will
-inform that the option is not recognized and will be ignored.
+inform that the option is not recognized.
 
 #### Do I Need to register deprecated options as recognized?
 
@@ -312,6 +333,10 @@ end
 
 ## Contributing
 
+This is a rapid "scratch your own itch" kind of project. It will make me really happy if it can be used used in your software anyhow. If you need something different than what is in it, or can solve us some bugs or add documentation, it will be very well received!
+
+Here is how you can help this gem:
+
 1. Fork it ( http://github.com/ricardovaleriano/optioning/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/ROADMAP.md

@@ -0,0 +1,3 @@
+# Roadmap
+
+  * [ ] thread safety

data/examples/file.rb

@@ -0,0 +1,38 @@
+begin
+  require "optioning"
+rescue LoadError
+  $:.unshift File.expand_path "../../lib", __FILE__
+  require "optioning"
+end
+
+class FileExample
+  def initialize(path, commit, content)
+    @content = content
+    @path, @commit = path, commit
+  end
+
+  def export
+    hasherize :path, :commit,
+      to_hash: ->(){},
+      store: "NO!",
+      persist: "I will persist!"
+  end
+
+  private
+
+  def hasherize(*values_and_options)
+    optioning = Optioning.new values_and_options
+    optioning.deprecate :to_hash, :to, "v2.0.0"
+    optioning.recognize :persist
+    optioning.process caller
+
+    puts "\n#{'*'* 80}"
+    puts "I should export the follow ivars: #{optioning.values}"
+    puts optioning.on :to
+    puts optioning.on :persist
+    puts optioning.on :store
+  end
+end
+
+file = FileExample.new('/some/file.rb', 'cfe9aacbc02528b', '#omg! such file!')
+file.export

data/lib/optioning/version.rb

@@ -1,3 +1,3 @@
 class Optioning
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optioning
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Ricardo Valeriano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,9 +67,9 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- ROADMAP.md
 - Rakefile
-- examples/client_maroto.rb
-- examples/module_maroto.rb
+- examples/file.rb
 - lib/deprecation.rb
 - lib/optioning.rb
 - lib/optioning/version.rb

data/examples/client_maroto.rb

@@ -1,6 +0,0 @@
-require_relative "./module_maroto"
-class Client
-  extend Maroto
-
-  hasherize :some_ivar, to_hash: ->(){}, store: "NO!", persist: "I will persist!"
-end

data/examples/module_maroto.rb

@@ -1,20 +0,0 @@
-begin
-  require "optioning"
-rescue LoadError => e
-  $:.unshift File.expand_path "../../lib", __FILE__
-  require "optioning"
-end
-
-module Maroto
-  def hasherize(*values_and_options)
-    optioning = Optioning.new values_and_options
-    optioning.deprecate :to_hash, :to, "v2.0.0"
-    optioning.recognize :persist
-    optioning.process caller
-
-    puts "\n"
-    puts "*" * 80
-    puts optioning.on :to
-    puts optioning.on :persist
-  end
-end