class2 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91ca10f950914ea029d15364b4722c064dc5d669
-  data.tar.gz: c1b657103a971487aa414c95c7f789959c1bd5bf
+  metadata.gz: ab6287d91741715040bde7550bf9a9a0de474d4b
+  data.tar.gz: 46e7ab44843d52de375a7a259f976e6c653e9d4a
 SHA512:
-  metadata.gz: fe9ece44a7faecc4b52dd0159c4fd0271ab38c65928d4ccdbdd2960ffb0abe8366951152fe2bc83b5fc3001b97758dcd3c9ae25f1fb19d91f665e459b97da5e7
-  data.tar.gz: 0294c237a509932691f6e4fd8f976b1d3d49aea607e27053e15681b94eb69a7f58e2ac7601bf7283a195e6405721d466a43834ffea5bf57800024b590655ac90
+  metadata.gz: 19d653a1b5f20940ecf956f3952ebeabfcd8761e249b9fb136d34d30baf975f3a4db4ef124e982863f3157e6538b7ee2e5853e06b8113b3535a0183c311d4059
+  data.tar.gz: ad13a618934fc32fbe6ac72d8c0ee6645358d5d35df5b732217bb2c632abfba6a07eb957f43b2ee86ce549da890fcf99c82e17d7eb3f7ae9edd4dba183e7c73d

data/Changes

@@ -1,3 +1,9 @@
+2017-08-15  v0.1.0
+--------------------
+* Add support for blocks
+* Add Class2::StrictConstructor
+* Bug fix: to_h conversion failure caused element to be skipped
+
 2017-08-10  v0.0.2
 --------------------
 * Add support for types

data/README.md

@@ -7,15 +7,13 @@ Easily create hierarchies of classes that support nested attributes, type conver
 ## Usage
 
 ```rb
-Class2(
-  :user => [
-    :name, :age,
-    :addresses => [
-      :city, :state, :zip,
-      :country => [ :name, :code ]
-    ]
-  ]
-)
+Class2 :user => [
+         :name, :age,
+         :addresses => [
+           :city, :state, :zip,
+           :country => [ :name, :code ]
+         ]
+       ]
 ```
 
 This creates 3 classes: `User`, `Address`, and `Country` with the following attribute accessors:
@@ -29,23 +27,22 @@ Each of these classes are created with [several additional methods](#methods).
 You can also specify types:
 
 ```rb
-Class2(
-  :user => {
-    :name => String,
-    :age  => Fixnum,
-    :addresses => [
-      :city, :state, :zip,  # No explicit types for these
-      :country => {
-        :name => String,
-        :code => String
-      }
-    ]
-  }
-)
+Class2 :user => {
+         :name => String,
+         :age  => Fixnum,
+         :addresses => [
+           :city, :state, :zip,  # No explicit types for these
+           :country => {
+             :name => String,
+             :code => String
+           }
+         ]
+       }
 ```
-Attributes without types are treated as is.
+An attempt is made to convert the attribute's type when a value is passed to the constructor
+or set via its accessor. Attributes without types are treated as is.
 
-After calling either one of the above you can do following:
+After calling either one of the above you can do the following:
 
 ```rb
 user = User.new(
@@ -74,11 +71,9 @@ user.addresses << address
 User.new(:name => "sshaw") == User.new(:name => "sshaw")  # true
 ```
 
-Unknown attributes passed to the constructor are ignored.
-
 `Class2` can create classes with typed attributes from example hashes.
 This makes it possible to build classes for things like API responses, using the API response
-itself -or a slightly modified version, see [Issues](#issues)- as the specification:
+itself as the specification:
 
 ```rb
 # From JSON.parse
@@ -99,9 +94,7 @@ response = [
   }
 ]
 
-Class2(
-  :commit => response.first
-)
+Class2 :commit => response.first
 
 commit = Commit.new(response.first)
 commit.author.name    # "sshaw"
@@ -128,17 +121,11 @@ Custom conversions are possible, just add the conversion to
 `Class2` can use an exiting namespace or create a new one:
 
 ```rb
-Class2(
-  My::Namespace,
-  :user => %i[name age]
-)
+Class2 My::Namespace, :user => %i[name age]
 
 My::Namespace::User.new(:name => "sshaw")
 
-Class2(
-  "New::Namespace",
-  :user => %i[name age]
-)
+Class2 "New::Namespace", :user => %i[name age]
 
 New::Namespace::User.new(:name => "sshaw")
 ```
@@ -168,60 +155,65 @@ Classes created by `Class2` will have:
 * `#eql?` and `#==`
 * `#hash`
 
-#### Custom Methods
+### Constructor
 
-Just open up the class and write them:
+The default constructor ignores unknown attributes.
+If you prefer to raise an exception include `Class2::StrictConstructor`:
 
 ```rb
-Class2(:user => :name)
-
-class User
-  def first_initial
-    name[0] if name
-  end
+Class2 :user => %w[id name age] do
+  include Class2::StrictConstructor
 end
-
-User.new(:name => "sshaw").first_initial
 ```
 
-## Issues
+Now an `ArgumentError` will be raised if anything but `id`, `name`, or
+`age` are passed in.
 
-Can't use plural attributes that are not collections.
-Here we want `:users` to be an attribute, not a type:
+Also see [Customizations](#customizations).
 
-```rb
-Class2(:foo => [ :users => [ :id, :age, :foo ] ])
-```
+### Customizations
 
-Instead you can use a `Set`
+To add methods or include modules just open up the class and write or include them:
 
 ```rb
-Class2(:foo => [ :users => Set.new([ :id, :age, :foo ]) ])
-```
+Class2 :user => :name
 
----
+class User
+  include SomeModule
 
-Building classes from example hashes will fail for arrays of scalars. For example:
+  def first_initial
+    name[0] if name
+  end
+end
 
-```rb
-user = { :name => "sshaw", :hobbies => ["screen-staring", "other thangz"] }
-Class2(:user => user)
+User.new(:name => "sshaw").first_initial
 ```
 
-Will fail because of `:hobbies`' value. It must be converted to:
+`Class2` does accept a block whose contents will be added to
+*every* class defined within the call:
 
 ```rb
-user = { :name => "sshaw", :hobbies => [] }
-Class2(:user => user)
+Class2 :user => :name, :address => :city do
+  include ActiveModel::Conversion
+  extend ActiveModel::Naming
+end
+
+User.new.model_name.route_key
+Address.new.model_name.route_key
 ```
 
----
+## See Also
 
-Others, I'm sure.
+The Perl modules that served as inspiration:
 
-## See Also
+* [`MooseX::NestedAttributesConstructor`](https://github.com/sshaw/MooseX-NestedAttributesConstructor)
+* [`Class::Tiny`](https://metacpan.org/pod/Class::Tiny)
+* [`Moose`](https://metacpan.org/pod/Moose), [`Moo`](https://metacpan.org/pod/Moo), and [`Mouse`](https://metacpan.org/pod/Mouse)
+* [`Type::Tiny`](https://metacpan.org/pod/Type::Tiny)
+* [`MooseX::Types`](https://metacpan.org/pod/MooseX::Types)
+* [`Rubyish`](https://metacpan.org/pod/Rubyish)
 
-The Perl module that served as the inspiration: [`MooseX::NestedAttributesConstructor`](https://github.com/sshaw/MooseX-NestedAttributesConstructor).
+Surely others I cannot remember...
 
 ## Author
 

data/lib/class2.rb

@@ -6,8 +6,8 @@ require "active_support/core_ext/string"
 
 require "class2/version"
 
-def Class2(*args)
-  Class2.new(*args)
+def Class2(*args, &block)
+  Class2.new(*args, &block)
 end
 
 class Class2
@@ -29,7 +29,7 @@ class Class2
   CONVERSIONS.default = lambda { |v| v }
 
   class << self
-    def new(*argz)
+    def new(*argz, &block)
       specs = argz
       namespace = Object
 
@@ -39,7 +39,7 @@ class Class2
 
       specs.each do |spec|
         spec = [spec] unless spec.respond_to?(:each)
-        spec.each { |klass, attributes| make_class(namespace, klass, attributes) }
+        spec.each { |klass, attributes| make_class(namespace, klass, attributes, block) }
       end
 
       nil
@@ -60,7 +60,7 @@ class Class2
 
       attributes = [attributes] unless attributes.is_a?(Array)
       attributes.compact.each do |attr|
-        # Just an attribute name, no type, so use default type String
+        # Just an attribute name, no type
         if !attr.is_a?(Hash)
           simple << { attr => nil }
           next
@@ -86,10 +86,10 @@ class Class2
       [ nested, simple ]
     end
 
-    def make_class(namespace, name, attributes)
+    def make_class(namespace, name, attributes, block)
       nested, simple = split_and_normalize_attributes(attributes)
       nested.each do |object|
-        object.each { |klass, attrs| make_class(namespace, klass, attrs) }
+        object.each { |klass, attrs| make_class(namespace, klass, attrs, block) }
       end
 
       make_method_name = lambda { |x| x.to_s.gsub(/[^\w]+/, "_") } # good enough
@@ -129,7 +129,7 @@ class Class2
                   begin
                     e.respond_to?(:to_h) ? e.to_h : e
                   rescue *errors
-                    # Give up
+                    e
                   end
                 end
               end
@@ -149,9 +149,21 @@ class Class2
           method, type = cfg.first
           method = make_method_name[method]
 
-          attr_reader method
+          # Use Enum somehow?
+          retval = if type == Array || type.is_a?(Array)
+                     "[]"
+                   elsif type == Hash || type.is_a?(Hash)
+                     "{}"
+                   else
+                     "nil"
+                   end
 
           class_eval <<-CODE
+            def #{method}
+              @#{method} = #{retval} unless defined? @#{method}
+              @#{method}
+            end
+
             def #{method}=(v)
               @#{method} = #{CONVERSIONS[type]["v"]}
             end
@@ -170,6 +182,9 @@ class Class2
           CODE
         end
 
+        # Do this last to allow for overriding the methods we define
+        class_eval(&block) unless block.nil?
+
         private
 
         def assign_attributes(attributes)
@@ -195,4 +210,25 @@ class Class2
       namespace.const_set(name.to_s.classify, klass)
     end
   end
+
+  #
+  # By default unknown arguments are ignored. <code>include<code>ing this will
+  # cause an ArgumentError to be raised if an attribute is unknown:
+  #
+  module StrictConstructor
+    def self.included(klass)
+      klass.class_eval do
+        def initialize(attributes = nil)
+          return unless attributes.is_a?(Hash)
+          assign_attributes(attributes)
+
+          accepted = to_h.keys
+          attributes.each do |name, _|
+            next if accepted.include?(name.respond_to?(:to_sym) ? name.to_sym : name)
+            raise ArgumentError, "unknown attribute: #{name}"
+          end
+        end
+      end
+    end
+  end
 end

data/lib/class2/version.rb

@@ -1,3 +1,3 @@
 class Class2
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class2
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport