block_configurable 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0835eaa0da15465594873dedfc834e28ca02221c
-  data.tar.gz: 24fb1fc30a11579a5da38a7d98a73f23df2e9d7d
+  metadata.gz: c16db92cffd0aa2c695abb35add01b294050c5b4
+  data.tar.gz: 1f1be3a9c3a4bc569e7e0c7ae349dd21a0fb6f59
 SHA512:
-  metadata.gz: bddd854d8a75024647a1bb7b4c37fd89956e10d2c787fcdc60393c44c72a99e7b9a655b9e7c41aa1f9bca791b004d63a49709a3c2f055e8a8d748ee37f8861f1
-  data.tar.gz: 21c0469b08b1323f2166f39b701ddbb49ea13d67af91d18131cdb93c5884ea4129a53ec6d816d9c9b7953a71d3b2eabef09f6320b864720ba289695a87b5b560
+  metadata.gz: 4347a2ffd104826dd9a97cc79dbb9ff4de0826c4152c4b46183388dcfae42e236b1c110dba71c04aac8643badc07c3ec2530a8a4110b4c16079801ff880ea238
+  data.tar.gz: bda47a8b19f0e58136c488e11a108d58550cdad8d565b9488e9451ae73ac7c0b74272f70c7a45cbd0f5ef1b7d4ccfb5e68d0dea3a2d2de2eb8d4e7d38942a9c1

data/README.md

@@ -1,6 +1,6 @@
 # BlockConfigurable
 
-[![Build Status](https://travis-ci.org/artemshitov/block_configurable.png?branch=master)](https://travis-ci.org/artemshitov/block_configurable) [![Code Climate](https://codeclimate.com/github/artemshitov/block_configurable.png)](https://codeclimate.com/github/artemshitov/block_configurable)
+[![Build Status](https://travis-ci.org/artemshitov/block_configurable.png?branch=master)](https://travis-ci.org/artemshitov/block_configurable) [![Code Climate](https://codeclimate.com/github/artemshitov/block_configurable.png)](https://codeclimate.com/github/artemshitov/block_configurable) [![Gem Version](https://badge.fury.io/rb/block_configurable.png)](http://badge.fury.io/rb/block_configurable)
 
 A little mixin to make your classes and modules configurable using either single statements or blocks.
 
@@ -12,38 +12,43 @@ Install as a standalone gem:
 
 Or include into your `Gemfile`:
 
-    gem 'block_configurable', '~> 0.9.0'
+```ruby
+gem 'block_configurable', '~> 0.10.0'
+```
 
 ## Usage
-    
+
+Set up class (or module). Only parameters explicitly listed will be available for configuration.
+
 ```ruby
 class MyClass
   include BlockConfigurable
 
-  config :param_with_default_value, 'A default!'
-  config :param_without_default_value
-  config :another_one
+  configurable :param_with_default_value, 'A default!'
+  configurable :param_without_default_value
+  configurable :another_one
 end
+```
 
-MyClass.configuration.param_with_default_value
-#=> 'A default!'
-
-MyClass.configuration.param_without_default_value
-#=> nil
+Configure it:
 
+```ruby
 MyClass.configure do |c|
-  c.param_with_default_value = 'My values, my rules'
   c.param_without_default_value = 'A value now!'
+  c.another_one = 'My values, my rules'
 end
 
-MyClass.configuration.param_with_default_value
-#=> 'My values, my rules'
+# or
+
+MyClass.configuration.another_one = 'My values, my rules'
+```
 
-MyClass.configuration.param_without_default_value
-#=> 'A value now!'
+Read configuration:
 
-MyClass.configuration.another_one = 'The third'
+```ruby
+MyClass.configuration.param_with_default_value
+#=> 'A default!'
 
 MyClass.configuration.another_one
-#=> 'The third'
+#=> 'My values, my rules'
 ```

data/lib/block_configurable/version.rb

@@ -1,3 +1,3 @@
 module BlockConfigurable
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/lib/block_configurable.rb

@@ -7,7 +7,7 @@ module BlockConfigurable
       @configuration ||= Configuration.new
     end
 
-    def config(param, default = nil)
+    def configurable(param, default = nil)
       configuration.add_config(param, default)
     end
 
@@ -18,6 +18,6 @@ module BlockConfigurable
   
   def self.included(receiver)
     receiver.extend ClassMethods
-    receiver.send :private_class_method, :config
+    receiver.send :private_class_method, :configurable
   end
 end

data/test/block_configurable/block_configurable_test.rb

@@ -4,16 +4,16 @@ require 'block_configurable'
 class Configurable
   include BlockConfigurable
 
-  config :value_with_default, 1
-  config :value_without_default, nil
-  config :value_to_change, 'a'
-  config :value_to_test_hash, :test
+  configurable :value_with_default, 1
+  configurable :value_without_default, nil
+  configurable :value_to_change, 'a'
+  configurable :value_to_test_hash, :test
 end
 
 module ConfigurableModule
   include BlockConfigurable
 
-  config :value_with_default, 1
+  configurable :value_with_default, 1
 end
 
 class BlockConfigurableTest < Minitest::Test

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: block_configurable
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Artem Shitov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2013-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler