context_builder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc7094c8368581bb8a384b57deac815028f2c015
+  data.tar.gz: 5835eed9347d8f2da14a68ef37304038bdd54142
+SHA512:
+  metadata.gz: 1b476f296a9e08a26102a914b413c96e678825bf40eade145dd811786bc23f617219f4f5eed2c84ed5c476b5653f7096b0cc47b339049c5b2f8f459371cb5f2f
+  data.tar.gz: c6c958d2ddee170cab52e0c90f0fdabc18748afdfe7675398f2a1df86b554689bb2689f181bc9d6e40e77ca8099d4fec893665bdc6905df17ee2b58a005ae17f

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 David McCullars
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David McCullars
+
+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,73 @@
+# ContextBuilder
+
+This gem provides a way of extending modules with context attributes.  Modules
+that extend Context will receive the class method :context_attr which is
+used to specify one or more context attributes that the extended module provides.
+Each of these attributes will be accessible by name on classes that include the
+extended module.  The value of that method is determined as the first non-nil
+value from a hash provided to initialize_context or one of any number of lookup_NAME
+methods in the class or any module included by the class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'context_builder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install context_builder
+
+## Example
+
+   module Personage
+
+     extend ContextBuilder
+
+     context_attr :name, :age
+     context_attr(:race) { |options| options[:race] || options[:ethnicity] }
+
+     def lookup_age
+       ENV['AGE']
+     end
+
+   end
+
+   class User
+
+     include Personage
+
+     def initialize(name)
+       initialize_context(:name => name, :ethnicity => 'unknown')
+     end
+
+     def lookup_age
+       'N/A' unless name == 'Greg'
+     end
+
+   end
+
+   User.new('Fred').inspect
+   >> #<User name=Fred age=N/A race=unknown>
+
+   ENV['AGE'] = '27'
+   User.new('Greg').inspect
+   >> #<User name=Greg age=27 race=unknown>
+
+## Usage Notes
+
+It is important to place 'extend Context' AFTER any self.included methods
+defined on the extended module.  Otherwise, the self.included method will
+overwrite the one from Context, rendering the 'extend' useless.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/context_builder/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/context_builder.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'context_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "context_builder"
+  spec.version       = ContextBuilder::VERSION
+  spec.authors       = ["David McCullars"]
+  spec.email         = ["david.mccullars@gmail.com"]
+  spec.summary       = %q{This gem provides a way of extending modules with context attributes.}
+  spec.description   = %q{This gem provides a way of extending modules with context attributes.}
+  spec.homepage      = "https://github.com/david-mccullars/context_builder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'simplecov', '~> 0.8'
+  spec.add_development_dependency 'simplecov-html', '~> 0.8'
+  spec.add_development_dependency 'simplecov-rcov', '~> 0.2'
+end

data/lib/context_builder.rb

@@ -0,0 +1,25 @@
+require "context_builder/version"
+
+module ContextBuilder
+
+  autoload :BaseClassDefiner, 'context_builder/base_class_definer'
+
+  def self.extended(base_mod)
+    base_mod.module_eval do
+      @__context_attrs = {}
+    end
+
+    orig_included = base_mod.method(:included)
+    base_mod.define_singleton_method(:included) do |base_class|
+      BaseClassDefiner.new(base_class).define_all(@__context_attrs)
+      orig_included.call(base_class)
+    end
+  end
+
+  def context_attr(*names, &block)
+    names.flatten.each do |name|
+      @__context_attrs[name.to_sym] = block
+    end
+  end
+
+end

data/lib/context_builder/base_class_definer.rb

@@ -0,0 +1,66 @@
+module ContextBuilder
+  class BaseClassDefiner
+
+    attr_reader :base_class
+
+    def initialize(base_class)
+      @base_class = base_class
+    end
+
+    def define_all(all_attrs)
+      define_initialize_context_method(all_attrs)
+      define_all_attr_methods(all_attrs)
+      define_context_method(all_attrs)
+      define_to_hash_method(all_attrs)
+      define_inspect_method(all_attrs)
+    end
+
+    private
+
+    def define_initialize_context_method(all_attrs)
+      base_class.send(:define_method, :initialize_context) do |options|
+        all_attrs.each do |name, block|
+          @__context ||= {}
+          @__context[name] = block ? block.call(options) : options[name]
+        end
+      end
+    end
+
+    def define_all_attr_methods(all_attrs)
+      all_attrs.keys.each do |name|
+        base_class.send(:define_method, name) do
+          @__context ||= {}
+          @__context[name] ||= [self.class, *self.class.included_modules].reduce(nil) do |val, mod|
+            val ||= begin
+              if mod.method_defined? "lookup_#{name}"
+                mod.instance_method("lookup_#{name}").bind(self).call
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def define_context_method(all_attrs)
+      base_class.send(:define_method, :context) do
+        all_attrs.keys.reduce({}) do |hash, name|
+          hash.merge! name => send(name)
+        end
+      end
+    end
+
+    def define_to_hash_method(all_attrs)
+      base_class.send(:define_method, :to_hash) do
+        context
+      end
+    end
+
+    def define_inspect_method(all_attrs)
+      base_class.send(:define_method, :inspect) do
+        data = to_hash.map { |a| a.join '=' }.join ', '
+        "#<#{self.class.name} #{data}>"
+      end
+    end
+
+  end
+end

data/lib/context_builder/version.rb

@@ -0,0 +1,3 @@
+module ContextBuilder
+  VERSION = "1.0.0"
+end

data/spec/lib/context_builder_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'context_builder'
+
+describe ContextBuilder do
+
+  let(:clazz) do
+    Class.new do
+      def lookup_bar
+        'bar from clazz'
+      end
+      def self.name
+        'TestClass'
+      end
+    end
+  end
+
+  let(:mod) do
+    Module.new do
+      extend ContextBuilder
+
+      context_attr :foo, :bar
+      context_attr(:baz) { |options| options[:not_baz] }
+
+      def lookup_bar
+        'bar from mod'
+      end
+
+      def lookup_foo
+        'foo from mod'
+      end
+    end
+  end
+
+  subject { clazz.tap { |c| c.send(:include, mod) }.new }
+
+  specify 'initialize context with options' do
+    subject.initialize_context(:foo => 12, :bar => 'stuff', :not_baz => 'weird, huh?')
+    expect(subject.to_hash).to eq(:foo => 12, :bar => 'stuff', :baz => 'weird, huh?')
+  end
+
+  specify 'initialize context from lookups' do
+    expect(subject.to_hash).to eq(:foo => 'foo from mod', :bar => 'bar from clazz', :baz => nil)
+  end
+
+  specify 'provides inspect method on extended modules' do
+    expect(subject.inspect).to eq('#<TestClass foo=foo from mod, bar=bar from clazz, baz=>')
+  end
+
+  specify 'preserve included on extended modules' do
+    mod2 = Module.new do
+      def self.included(base)
+        base.send(:define_method, :inspect) do
+          'preserved inspect'
+        end
+      end
+      extend ContextBuilder
+    end
+    clazz2 = Class.new { include mod2 }
+    expect(clazz2.new.inspect).to eq('preserved inspect')
+  end
+
+  specify 'overwrite included on extended modules' do
+    mod.module_eval do
+      def self.included(base)
+        # By defining this AFTER 'extend Context', we kill self.included
+        # and prevent Context from doing anything to clazz
+      end
+    end
+    expect { subject.initialize_context }.to raise_error(/undefined method/)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'simplecov'
+require 'simplecov-rcov'
+SimpleCov.start
+SimpleCov.formatter = Class.new do
+  def format(result)
+     SimpleCov::Formatter::HTMLFormatter.new.format(result)
+     SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: context_builder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David McCullars
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov-html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: This gem provides a way of extending modules with context attributes.
+email:
+- david.mccullars@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- context_builder.gemspec
+- lib/context_builder.rb
+- lib/context_builder/base_class_definer.rb
+- lib/context_builder/version.rb
+- spec/lib/context_builder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/david-mccullars/context_builder
+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.2.2
+signing_key: 
+specification_version: 4
+summary: This gem provides a way of extending modules with context attributes.
+test_files:
+- spec/lib/context_builder_spec.rb
+- spec/spec_helper.rb