constructable 0.1.0 → 0.2.0

data/README.markdown

@@ -10,20 +10,20 @@ Provides a powerful class macro for defining and configuring constructable attri
 * Provides a granular control on how accessible your attributes are(no need to define attr_* yourself)
 
 ## Usage
-<pre><code>
+```ruby
 class Foo
   constructable [:bar, :readable => true], [:baz, :required => true, :readable => true]
 end
 
 foo = Foo.new(bar: 5)
-\# raises AttributeError, ':baz is a required attribute'
+# raises AttributeError, ':baz is a required attribute'
 
 foo = Foo.new(baz: 7, bar: 5)
 
 foo.bar
-\# => 5
+# => 5
 foo.baz
-\# => 7
+# => 7
 
 class ProgrammingLanguage
   constructable [:paradigms,
@@ -33,12 +33,12 @@ class ProgrammingLanguage
 end
 
 c = ProgrammingLanguage.new(paradigms: :functional)
-\#  raises AttributeError, ':paradigms needs to be of type Array'
+#  raises AttributeError, ':paradigms needs to be of type Array'
 
 ruby = ProgrammingLanguage.new(paradigms: [:object_oriented, :functional])
 ruby.paradigms
-\# => [:object_oriented, :functional]
-</pre></code>
+# => [:object_oriented, :functional]
+```
 
 
 ## Contributing to constructable

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/constructable.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{constructable}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Manuel Korfmann"]
+  s.date = %q{2011-06-09}
+  s.description = %q{
+Adds the class macro Class#constructable to easily define what attributes a Class accepts provided as a hash to Class#new.
+Attributes can be configured in their behaviour in case they are not provided or are in the wrong format.
+Their default value can also be defined and you have granular control on how accessible your attribute is.
+See the documentation for Constructable::Constructable#constructable or the README for more information.
+  }
+  s.email = %q{manu@korfmann.info}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "constructable.gemspec",
+    "lib/constructable.rb",
+    "lib/constructable/attribute.rb",
+    "lib/constructable/constructable.rb",
+    "lib/constructable/constructor.rb",
+    "lib/constructable/core_ext.rb",
+    "lib/constructable/exceptions.rb",
+    "test/constructable/test_attribute.rb",
+    "test/constructable/test_constructable.rb",
+    "test/constructable/test_constructor.rb",
+    "test/helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mkorfmann/constructable}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Makes constructing objects through an attributes hash easier}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/constructable/attribute.rb

@@ -1,7 +1,8 @@
 module Constructable
   class Attribute
-    ATTRIBUTES = [:writable, :readable, :accessible, :required, :validate, :default, :validate_type, :converter]
+    ATTRIBUTES = [:group, :writable, :readable, :accessible, :required, :validate, :default, :validate_type, :converter]
     attr_accessor *ATTRIBUTES, :name
+    attr_reader :value
 
     REQUIRED_REQUIREMENT = {
       name: :required,
@@ -24,8 +25,8 @@ module Constructable
 
     def initialize(name, options = {})
       @name = name
-      options.each do |option, value|
-        self.send(:"#{option}=", value )
+      ATTRIBUTES.each do |attribute|
+        self.send(:"#{attribute}=", options[attribute])
       end
     end
 
@@ -59,7 +60,7 @@ module Constructable
       else
         check_for_requirement(REQUIRED_REQUIREMENT, constructor_hash)
         self.default
-      end
+      end.tap { |value| @value = value }
     end
   end
 end

data/lib/constructable/constructor.rb

@@ -15,14 +15,25 @@ module Constructable
 
 
     def define_attributes(attributes)
-      @attributes.concat attributes.map! { |c| Attribute.new(*c) }
+      attributes = generate_attributes(attributes)
+      @attributes.concat attributes
+
+      attributes = @attributes
       attributes.each do |attribute|
         @klass.class_eval do
-          setter = :"#{attribute.name}="
-          define_method(attribute.name) { instance_variable_get attribute.ivar_symbol }
-          private attribute.name unless attribute.readable
-          define_method(setter) { |value| instance_variable_set attribute.ivar_symbol, attribute.process({ attribute.name => value}) }
-          private setter unless attribute.writable
+
+          attr_reader attribute.name if attribute.readable
+
+          define_method(:"#{attribute.name}=") do |value|
+            instance_variable_set attribute.ivar_symbol, attribute.process({ attribute.name => value})
+          end if attribute.writable
+
+          define_method(attribute.group) do
+            attributes.group_by(&:group)[attribute.group].inject({}) do |hash, attribute|
+              hash[attribute.name] = attribute.value
+              hash
+            end
+          end if attribute.group && !method_defined?(attribute.group)
         end
       end
     end
@@ -33,5 +44,19 @@ module Constructable
         obj.instance_variable_set(attributes.ivar_symbol, attributes.process(constructor_hash))
       end
     end
+
+    def generate_attributes(attributes)
+      attributes.map do |dynamic_args|
+        if Hash === dynamic_args
+          dynamic_args.map do |name, attributes|
+            attributes.map do |attribute|
+              Attribute.new(*attribute).tap { |a| a.group = dynamic_args.keys.first }
+            end
+          end
+        else
+          Attribute.new(*dynamic_args)
+        end
+      end.flatten
+    end
   end
 end

data/test/constructable/test_attribute.rb

@@ -1,6 +1,17 @@
 require 'helper'
 include Constructable
 describe 'Attribute' do
+
+  describe 'value' do
+    it 'returns the last processed value' do
+      attribute = Attribute.new(:foo)
+      attribute.process({foo: :bar})
+      assert_equal :bar, attribute.value
+      attribute.process({foo: 1})
+      assert_equal 1, attribute.value
+    end
+  end
+
   describe 'name' do
     it 'returns the name' do
       attribute = Attribute.new(:attribute)

data/test/constructable/test_constructor.rb

@@ -14,6 +14,26 @@ describe 'Constructor' do
     end
   end
 
+  describe 'Attribute#group' do
+    it 'returns attributes included in the group along with their values' do
+      @klass.constructable [:foo, group: :foobar], [:bar, group: :foobar]
+      instance = @klass.new(foo: 1, bar: 2)
+      assert_equal({foo: 1, bar: 2}, instance.foobar)
+    end
+
+    it 'ONLY returns attributes included in that group' do
+      @klass.constructable [:foo, group: :foobar], [:bar]
+      instance = @klass.new(foo: 1, bar: 2)
+      assert_equal({foo: 1}, instance.foobar)
+    end
+
+    it 'has a nice syntax' do
+      @klass.constructable foobar: [:foo, :bar]
+      instance = @klass.new(foo: 1, bar: 2)
+      assert_equal({foo: 1, bar: 2}, instance.foobar)
+    end
+  end
+
   describe 'permission' do
     it 'should allow writable attributes' do
       @klass.constructable [:writable_attribute, writable: true]

metadata

@@ -2,7 +2,7 @@
 name: constructable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Manuel Korfmann
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-08 00:00:00 +02:00
+date: 2011-06-09 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,6 +79,7 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- constructable.gemspec
 - lib/constructable.rb
 - lib/constructable/attribute.rb
 - lib/constructable/constructable.rb
@@ -103,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2461341662544041366
+      hash: -4108706002012057813
       segments: 
       - 0
       version: "0"