block_configurable 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0835eaa0da15465594873dedfc834e28ca02221c
+  data.tar.gz: 24fb1fc30a11579a5da38a7d98a73f23df2e9d7d
+SHA512:
+  metadata.gz: bddd854d8a75024647a1bb7b4c37fd89956e10d2c787fcdc60393c44c72a99e7b9a655b9e7c41aa1f9bca791b004d63a49709a3c2f055e8a8d748ee37f8861f1
+  data.tar.gz: 21c0469b08b1323f2166f39b701ddbb49ea13d67af91d18131cdb93c5884ea4129a53ec6d816d9c9b7953a71d3b2eabef09f6320b864720ba289695a87b5b560

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,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Artem Shitov
+
+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,49 @@
+# 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)
+
+A little mixin to make your classes and modules configurable using either single statements or blocks.
+
+## Installation
+
+Install as a standalone gem:
+
+    gem install block_configurable
+
+Or include into your `Gemfile`:
+
+    gem 'block_configurable', '~> 0.9.0'
+
+## Usage
+    
+```ruby
+class MyClass
+  include BlockConfigurable
+
+  config :param_with_default_value, 'A default!'
+  config :param_without_default_value
+  config :another_one
+end
+
+MyClass.configuration.param_with_default_value
+#=> 'A default!'
+
+MyClass.configuration.param_without_default_value
+#=> nil
+
+MyClass.configure do |c|
+  c.param_with_default_value = 'My values, my rules'
+  c.param_without_default_value = 'A value now!'
+end
+
+MyClass.configuration.param_with_default_value
+#=> 'My values, my rules'
+
+MyClass.configuration.param_without_default_value
+#=> 'A value now!'
+
+MyClass.configuration.another_one = 'The third'
+
+MyClass.configuration.another_one
+#=> 'The third'
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb', 'test/**/*_test.rb']
+end
+
+task :default => :test

data/block_configurable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'block_configurable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "block_configurable"
+  spec.version       = BlockConfigurable::VERSION
+  spec.authors       = ["Artem Shitov"]
+  spec.email         = ["inbox@artemshitov.ru"]
+  spec.description   = %q{A little mixin to make your classes and modules configurable using either single statements or blocks.}
+  spec.summary       = %q{A little mixin to make your classes and modules configurable}
+  spec.homepage      = "https://github.com/artemshitov/block_configurable"
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", '~> 5.0.6'
+end

data/lib/block_configurable.rb

@@ -0,0 +1,23 @@
+require 'block_configurable/configuration'
+require "block_configurable/version"
+
+module BlockConfigurable
+  module ClassMethods
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def config(param, default = nil)
+      configuration.add_config(param, default)
+    end
+
+    def configure(&block)
+      yield(configuration)
+    end
+  end
+  
+  def self.included(receiver)
+    receiver.extend ClassMethods
+    receiver.send :private_class_method, :config
+  end
+end

data/lib/block_configurable/configuration.rb

@@ -0,0 +1,25 @@
+module BlockConfigurable
+  class Configuration
+    def add_config(param, default = nil)
+      instance_eval %Q{
+        def #{param}
+          @#{param}
+        end
+
+        def #{param}=(value)
+          @#{param} = value
+        end
+      }
+      
+      instance_variable_set "@#{param}", default
+    end
+
+    def to_h
+      instance_variables.reduce(Hash.new) do |a, e|
+        a.merge(e[1..-1].to_sym => instance_variable_get(e))
+      end
+    end
+
+    alias_method :to_hash, :to_h
+  end
+end

data/lib/block_configurable/version.rb

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

data/test/block_configurable/block_configurable_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+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
+end
+
+module ConfigurableModule
+  include BlockConfigurable
+
+  config :value_with_default, 1
+end
+
+class BlockConfigurableTest < Minitest::Test
+  attr_reader :configuration
+
+  def setup
+    @configuration = Configurable.configuration
+  end
+
+  def test_default_values
+    assert_equal 1, configuration.value_with_default
+    assert_nil configuration.value_without_default
+  end
+
+  def test_can_be_configured_with_block
+    assert_equal 'a', configuration.value_to_change
+
+    Configurable.configure do |c|
+      c.value_to_change = 'b'
+    end
+
+    assert_equal 'b', configuration.value_to_change
+  end
+
+  def test_can_be_converted_to_hash
+    assert_equal 4, configuration.to_hash.size
+    assert_equal :test, configuration.to_h[:value_to_test_hash]
+  end
+
+  def test_can_be_included_in_a_module_too
+    assert_equal 1, ConfigurableModule.configuration.value_with_default
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'minitest/autorun'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: block_configurable
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Artem Shitov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+description: A little mixin to make your classes and modules configurable using either
+  single statements or blocks.
+email:
+- inbox@artemshitov.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- block_configurable.gemspec
+- lib/block_configurable.rb
+- lib/block_configurable/configuration.rb
+- lib/block_configurable/version.rb
+- test/block_configurable/block_configurable_test.rb
+- test/test_helper.rb
+homepage: https://github.com/artemshitov/block_configurable
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: A little mixin to make your classes and modules configurable
+test_files:
+- test/block_configurable/block_configurable_test.rb
+- test/test_helper.rb