class2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3ba3ccb4eb642b385d3878ba4861cfcfdd66aaa
-  data.tar.gz: 7f34029b8614857d44725173638ef3263b68cb7c
+  metadata.gz: 91ca10f950914ea029d15364b4722c064dc5d669
+  data.tar.gz: c1b657103a971487aa414c95c7f789959c1bd5bf
 SHA512:
-  metadata.gz: fd9f09822c3eb65d5b3e2584ea5bf3011d5421a232457657b658b3a54b3acf34873d7d3d36e93644c38e338d89915159ba085989c70aad99deb52a92d6235950
-  data.tar.gz: 05720dd6b75a9ed646b833f0ecdc41163ff68faa25fa238366bc439f0fa627e1339ddd1836a3e42b26f50b86abed1c3c698d86f2dbeec5c1e681121cc1b166a3
+  metadata.gz: fe9ece44a7faecc4b52dd0159c4fd0271ab38c65928d4ccdbdd2960ffb0abe8366951152fe2bc83b5fc3001b97758dcd3c9ae25f1fb19d91f665e459b97da5e7
+  data.tar.gz: 0294c237a509932691f6e4fd8f976b1d3d49aea607e27053e15681b94eb69a7f58e2ac7601bf7283a195e6405721d466a43834ffea5bf57800024b590655ac90

data/.gitignore

@@ -93,7 +93,7 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/Changes

@@ -0,0 +1,5 @@
+2017-08-10  v0.0.2
+--------------------
+* Add support for types
+* Bug fix: don't attempt to create invalid method names
+* Bug fix: don't assume constructor arg is a Hash

data/README.md

@@ -1,6 +1,6 @@
 # Class2
 
-Easily create hierarchies of classes that support nested attributes, equality, and more.
+Easily create hierarchies of classes that support nested attributes, type conversion, equality, and more.
 
 [![Build Status](https://travis-ci.org/sshaw/class2.svg?branch=master)](https://travis-ci.org/sshaw/class2)
 
@@ -24,9 +24,28 @@ This creates 3 classes: `User`, `Address`, and `Country` with the following attr
 * `Address`: city, state, zip, country
 * `Country`: name, code
 
-Each of these classes also contain [several additional methods](#methods).
+Each of these classes are created with [several additional methods](#methods).
 
-Example:
+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
+      }
+    ]
+  }
+)
+```
+Attributes without types are treated as is.
+
+After calling either one of the above you can do following:
 
 ```rb
 user = User.new(
@@ -42,22 +61,68 @@ user = User.new(
   ]
 )
 
-p user.name                  # "sshaw"
-p user.addresses.size        # 3
-p user.addresses.first.city  # "LA"
+user.name                  # "sshaw"
+user.addresses.size        # 3
+user.addresses.first.city  # "LA"
+user.to_h                  # {:name => "sshaw", :age => 99, :addresses => [ { ... } ]}
 
-# Keys can be strings too
+# keys can be strings too
 country = Country.new("name" => "America", "code" => "US")
 address = Address.new(:city => "Da Bay", :state => "CA", :country => country)
 user.addresses << address
 
-p User.new(:name => "sshaw") == User.new(:name => "sshaw")  # true
+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:
 
-Class2(:foo, :bar => :baz)
-Foo.new
-Bar.new(:baz => 123)
+```rb
+# From JSON.parse
+# of https://api.github.com/repos/sshaw/selfie_formatter/commits
+response = [
+  {
+    "sha" => "f52f1ed9144e1f73346176ab79a61af78df1b6bd",
+    "commit" => {
+      "author"=> {
+        "name"=>"sshaw",
+        "email"=>"skye.shaw@gmail.com",
+        "date"=>"2016-06-30T03:51:00Z"
+      }
+    },
+    "comment_count": 0
+
+    # snip full response
+  }
+]
+
+Class2(
+  :commit => response.first
+)
+
+commit = Commit.new(response.first)
+commit.author.name    # "sshaw"
+commit.comment_count  # 0
 ```
 
+### Conversions
+
+You can use any of these classes or their instances in your class definitions:
+
+* `Array`
+* `Date`
+* `DateTime`
+* `Float`
+* `Hash`
+* `Integer`/`Fixnum` - either one will cause a `Fixnum` conversion
+* `TrueClass`/`FalseClass` - either one will cause a boolean conversion
+
+Custom conversions are possible, just add the conversion to
+[`Class2::CONVERSIONS`](https://github.com/sshaw/class2/blob/517239afc76a4d80677e169958a1dc7836726659/lib/class2.rb#L14-L29)
+
 ### Namespaces
 
 `Class2` can use an exiting namespace or create a new one:
@@ -82,9 +147,13 @@ New::Namespace::User.new(:name => "sshaw")
 
 `Class2` uses
 [`String#classify`](http://api.rubyonrails.org/classes/String.html#method-i-classify)
-to turn keys into class names. `:foo` will be `Foo`, `:foo_bars` will
-be `FooBar`.  It also uses it to turn plural attribute names into
-singular classes. An `:addresses` attribute will result in a class named
+to turn keys into class names: `:foo` will be `Foo`, `:foo_bars` will
+be `FooBar`.
+
+Plural keys with an array value are always assumed to be accessors for
+a collection and will default to returning an `Array`. `#classify` is
+used to derive the class names from the plural attribute names. An
+`:addresses` key with an `Array` value will result in a class named
 `Address` being created.
 
 Plurality is determined by [`String#pluralize`](http://api.rubyonrails.org/classes/String.html#method-i-pluralize).
@@ -115,6 +184,41 @@ end
 User.new(:name => "sshaw").first_initial
 ```
 
+## Issues
+
+Can't use plural attributes that are not collections.
+Here we want `:users` to be an attribute, not a type:
+
+```rb
+Class2(:foo => [ :users => [ :id, :age, :foo ] ])
+```
+
+Instead you can use a `Set`
+
+```rb
+Class2(:foo => [ :users => Set.new([ :id, :age, :foo ]) ])
+```
+
+---
+
+Building classes from example hashes will fail for arrays of scalars. For example:
+
+```rb
+user = { :name => "sshaw", :hobbies => ["screen-staring", "other thangz"] }
+Class2(:user => user)
+```
+
+Will fail because of `:hobbies`' value. It must be converted to:
+
+```rb
+user = { :name => "sshaw", :hobbies => [] }
+Class2(:user => user)
+```
+
+---
+
+Others, I'm sure.
+
 ## See Also
 
 The Perl module that served as the inspiration: [`MooseX::NestedAttributesConstructor`](https://github.com/sshaw/MooseX-NestedAttributesConstructor).

data/class2.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Skye Shaw"]
   spec.email         = ["skye.shaw@gmail.com"]
 
-  spec.summary       = %q{Easily create hierarchies of classes that support nested attributes, equality, and more.}
+  spec.summary       = %q{Easily create hierarchies of classes that support nested attributes, type conversion, equality, and more.}
   spec.homepage      = "https://github.com/sshaw/class2"
   spec.license       = "MIT"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", ">= 3.0"
+  spec.add_dependency "activesupport", ">= 3.2"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/class2.rb

@@ -1,14 +1,33 @@
 # coding: utf-8
 
-require "class2/version"
+require "date"
 require "active_support/core_ext/module"
 require "active_support/core_ext/string"
 
+require "class2/version"
+
 def Class2(*args)
   Class2.new(*args)
 end
 
 class Class2
+  CONVERSIONS = {
+    Array     => lambda { |v| "Array(#{v})" },
+    Date      => lambda { |v| "Date.parse(#{v})" },
+    DateTime  => lambda { |v| "DateTime.parse(#{v})" },
+    Float     => lambda { |v| "Float(#{v})" },
+    Hash      => lambda { |v| sprintf "%s.respond_to?(:to_h) ? %s.to_h : %s", v, v, v },
+    Integer   => lambda { |v| "Integer(#{v})" },
+    String    => lambda { |v| "String(#{v})" },
+    TrueClass => lambda do |v|
+      sprintf '["1", 1, 1.0, true].freeze.include?(%s.is_a?(String) ? %s.strip : %s)', v, v, v
+    end
+  }
+
+  CONVERSIONS[FalseClass] = CONVERSIONS[TrueClass]
+  CONVERSIONS[Fixnum] = CONVERSIONS[Integer]
+  CONVERSIONS.default = lambda { |v| v }
+
   class << self
     def new(*argz)
       specs = argz
@@ -35,17 +54,50 @@ class Class2
       end
     end
 
-    def make_class(namespace, name, attributes)
+    def split_and_normalize_attributes(attributes)
+      nested = []
+      simple = []
+
       attributes = [attributes] unless attributes.is_a?(Array)
+      attributes.compact.each do |attr|
+        # Just an attribute name, no type, so use default type String
+        if !attr.is_a?(Hash)
+          simple << { attr => nil }
+          next
+        end
+
+        attr.each do |k, v|
+          if v.is_a?(Hash) || v.is_a?(Array)
+            if v.empty?
+              # If it's empty it's not a nested spec, the attributes type is a Hash or Array
+              simple << { k => v.class }
+            else
+              nested << { k => v }
+            end
+          else
+            # Type can be a class name or an instance
+            # If it's an instance, use its type
+            v = v.class unless v.is_a?(Class)
+            simple << { k => v }
+          end
+        end
+      end
+
+      [ nested, simple ]
+    end
 
-      nested, simple = attributes.compact.partition { |e| e.is_a?(Hash) }
+    def make_class(namespace, name, attributes)
+      nested, simple = split_and_normalize_attributes(attributes)
       nested.each do |object|
         object.each { |klass, attrs| make_class(namespace, klass, attrs) }
       end
 
+      make_method_name = lambda { |x| x.to_s.gsub(/[^\w]+/, "_") } # good enough
+
       klass = Class.new do
         def initialize(attributes = nil)
-          assign_attributes(attributes || {})
+          return unless attributes.is_a?(Hash)
+          assign_attributes(attributes)
         end
 
         class_eval <<-CODE
@@ -62,21 +114,54 @@ class Class2
 
           def to_h
             hash = {}
-            (#{simple + nested.map { |n| n.keys.first }}).each do |name|
+            (#{simple.map { |n| n.keys.first } + nested.map { |n| n.keys.first }}).each do |name|
               hash[name] = public_send(name)
-              hash[name] = hash[name].to_h if hash[name].respond_to?(:to_h)
+              next unless hash[name].respond_to?(:to_h)
+
+              errors = [ ArgumentError, TypeError ]
+              # Seems needlessly complicated, why doesn't Hash() do some of this?
+              begin
+                hash[name] = hash[name].to_h
+                # to_h is dependent on its contents
+              rescue *errors
+                next unless hash[name].is_a?(Enumerable)
+                hash[name] = hash[name].map do |e|
+                  begin
+                    e.respond_to?(:to_h) ? e.to_h : e
+                  rescue *errors
+                    # Give up
+                  end
+                end
+              end
             end
 
             hash
           end
+
+          def __nested_attributes
+            #{nested.map { |n| n.keys.first.to_sym }}.freeze
+          end
+
+          private :__nested_attributes
         CODE
 
-        simple.each { |method| attr_accessor method }
+        simple.each do |cfg|
+          method, type = cfg.first
+          method = make_method_name[method]
+
+          attr_reader method
+
+          class_eval <<-CODE
+            def #{method}=(v)
+              @#{method} = #{CONVERSIONS[type]["v"]}
+            end
+          CODE
+        end
 
         nested.map { |n| n.keys.first }.each do |method, _|
+          method = make_method_name[method]
           attr_writer method
 
-          method = method.to_s
           retval = method == method.pluralize ? "[]" : "#{method.classify}.new"
           class_eval <<-CODE
             def #{method}
@@ -89,17 +174,20 @@ class Class2
 
         def assign_attributes(attributes)
           attributes.each do |key, value|
-            if value.is_a?(Hash) || value.is_a?(Array)
-              name  = key.to_s.classify
+            if __nested_attributes.include?(key.respond_to?(:to_sym) ? key.to_sym : key) &&
+               (value.is_a?(Hash) || value.is_a?(Array))
+
+              name = key.to_s.classify
 
               # Only look in our namespace to prevent unwanted lookup
               next unless self.class.parent.const_defined?(name)
-              klass = self.class.parent.const_get(name)
 
+              klass = self.class.parent.const_get(name)
               value = value.is_a?(Hash) ? klass.new(value) : value.map { |v| klass.new(v) }
             end
 
-            public_send("#{key}=", value)
+            method = "#{key}="
+            public_send(method, value) if respond_to?(method)
           end
         end
       end

data/lib/class2/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-06 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Changes
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -105,6 +106,6 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Easily create hierarchies of classes that support nested attributes, equality,
-  and more.
+summary: Easily create hierarchies of classes that support nested attributes, type
+  conversion, equality, and more.
 test_files: []