class2 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9de74e43eb48f696e8284882f70046f2e824f1bf
-  data.tar.gz: 4de24fa14eb525838acb447c0d4bb79d3f7eff04
+  metadata.gz: a06a22bea52408ffd64b85a1adaca09f92d9c01b
+  data.tar.gz: ef14964e9c023946f7fefb3c6b68eabe2b074007
 SHA512:
-  metadata.gz: f6ebc7cf450ae0324f32f96bf8e6fe4349e10c8d65a32bc37f341cf872d38b508475a41bf198a8af93cdec6bf5628489206c6dc7ed44ac5dac7e01b06be4ef5e
-  data.tar.gz: f7b3b93aa9b066835095184cb2265f5faddd4c857bb60494e6dd0775bb4822868039bfcec6673498bd5c9a064f0dcb3270f86083a340378e98eb61546f5c4117
+  metadata.gz: ce1b018403485200bf1348d45eb77c4d4e3c49158233c351b573eb1d4fead11843c036a7c8c3061b2f87700d79a46818273281bf635956030f978a879cb03645
+  data.tar.gz: c43d375dfa1f161163da622010932aab022736e155f850669fc37258e513db5bcfc251f3dea6160c277e290e7bb0b5373bb1721a302542796838fc47200b1e02

data/.travis.yml

@@ -1,8 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.0
-  - 2.4.0
+  - 2.3
+  - 2.4
+  - 2.5
 
 before_install: gem install bundler
 notifications:

data/Changes

@@ -1,3 +1,10 @@
+2018-05-27  v0.4.0
+--------------------
+* Fix conversion bug when a module is used as a type specifier
+* Fix Fixnum deprecation warnings
+* Add support for JSON serialization and accessor formats that differ from definition
+* Add method that modules can use for initialization
+
 2017-12-04  v0.3.0
 --------------------
 * For attributes with a type of String don't convert nil to an empty string

data/README.md

@@ -30,7 +30,7 @@ Each of these classes are created with
 ```rb
 class2 :user => {
          :name => String,
-         :age  => Fixnum,
+         :age  => Integer,
          :addresses => [
            :city, :state, :zip,  # No explicit types for these
            :country => {
@@ -95,13 +95,37 @@ response = [
   }
 ]
 
-class2 :commit => response.first
+class2 :commit => response.first do
+  include Class2::SnakeCase::JSON
+end
 
 commit = Commit.new(response.first)
 commit.author.name    # "sshaw"
 commit.comment_count  # 0
+JSON.dump(commit)
 ```
 
+If the JSON uses `camelCase` but you want your class to use `snake_case` you can do the following:
+
+```rb
+class2 "commit" => { "camelCase" => { "someKey" => 123, "anotherKey" => 456 } } do
+  include Class2::SnakeCase::Attributes # snake_case accessors
+  include Class2::LowerCamelCase::JSON  # but serialize using camelCase
+end
+
+commit = Commit.new(:camel_case => { :some_key => 55 })
+commit.camel_case.some_key # 55
+
+commit = Commit.new(:camelCase => { :someKey => 55 })
+commit.camel_case.some_key # 55
+```
+
+For more info on accessor formats and JSON see:
+
+* [`Class2::SnakeCase`](https://www.rubydoc.info/gems/class2/Class2/SnakeCase)
+* [`Class2::UpperCamelCase`](https://www.rubydoc.info/gems/class2/Class2/UpperCamelCase)
+* [`Class2::LowerCamelCase`](https://www.rubydoc.info/gems/class2/Class2/LowerCamelCase)
+
 ### class2 API
 
 The are 3 ways to use class2. Pick the one that suites your style and/or requirements:
@@ -142,7 +166,7 @@ You can use any of these classes or their instances in your class definitions:
 * `DateTime`
 * `Float`
 * `Hash`
-* `Integer`/`Fixnum` - either one will cause a `Fixnum` conversion
+* `Integer`
 * `TrueClass`/`FalseClass` - either one will cause a boolean conversion
 
 Custom conversions are possible, just add the conversion to
@@ -221,6 +245,7 @@ Now an `ArgumentError` will be raised if anything but `id`, `name`, or
 
 Also see [Customizations](#customizations).
 
+
 ## See Also
 
 The Perl modules that served as inspiration:

data/lib/class2.rb

@@ -1,8 +1,9 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 require "date"
+require "json"
 require "active_support/core_ext/module"
-require "active_support/core_ext/string"
+require "active_support/inflector"
 
 require "class2/version"
 
@@ -37,7 +38,7 @@ class Class2
   }
 
   CONVERSIONS[FalseClass] = CONVERSIONS[TrueClass]
-  CONVERSIONS[Fixnum] = CONVERSIONS[Integer]
+  CONVERSIONS[Fixnum] = CONVERSIONS[Integer] if defined?(Fixnum)
   CONVERSIONS.default = lambda { |v| v }
 
   class << self
@@ -91,7 +92,7 @@ class Class2
           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)
+            v = v.class unless v.is_a?(Class) || v.is_a?(Module)
             simple << { k => v }
           end
         end
@@ -113,8 +114,7 @@ class Class2
 
       klass = Class.new do
         def initialize(attributes = nil)
-          return unless attributes.is_a?(Hash)
-          assign_attributes(attributes)
+          __initialize(attributes)
         end
 
         class_eval <<-CODE, __FILE__, __LINE__
@@ -127,11 +127,11 @@ class Class2
             to_h == other.to_h
           end
 
-          alias :eql? :==
+          alias eql? ==
 
           def to_h
             hash = {}
-            (#{simple.map { |n| n.keys.first } + nested.map { |n| n.keys.first }}).each do |name|
+            self.class.__attributes.each do |name|
               hash[name] = v = public_send(name)
               # Don't turn nil into a Hash
               next if v.nil? || !v.respond_to?(:to_h)
@@ -158,11 +158,13 @@ class Class2
             hash
           end
 
-          def __nested_attributes
+          def self.__nested_attributes
             #{nested.map { |n| n.keys.first.to_sym }}.freeze
           end
 
-          private :__nested_attributes
+          def self.__attributes
+            (#{simple.map { |n| n.keys.first.to_sym }} + __nested_attributes).freeze
+          end
         CODE
 
         simple.each do |cfg|
@@ -205,11 +207,18 @@ class Class2
         # Do this last to allow for overriding the methods we define
         class_eval(&block) unless block.nil?
 
+        protected
+
+        def __initialize(attributes)
+          return unless attributes.is_a?(Hash)
+          assign_attributes(attributes)
+        end
+
         private
 
         def assign_attributes(attributes)
           attributes.each do |key, value|
-            if __nested_attributes.include?(key.respond_to?(:to_sym) ? key.to_sym : key) &&
+            if self.class.__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
@@ -233,22 +242,143 @@ class Class2
 
   #
   # By default unknown arguments are ignored. <code>include<code>ing this will
-  # cause an ArgumentError to be raised if an attribute is unknown:
+  # 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
+          return unless __initialize(attributes)
           attributes.each do |name, _|
-            next if accepted.include?(name.respond_to?(:to_sym) ? name.to_sym : name)
+            next if self.class.__attributes.include?(name.respond_to?(:to_sym) ? name.to_sym : name)
             raise ArgumentError, "unknown attribute: #{name}"
           end
         end
       end
     end
   end
+
+  #
+  # Support +CamelCase+ attributes. See Class2::SnakeCase.
+  #
+  module UpperCamelCase
+    module Attributes
+      def self.included(klass)
+        Util.convert_attributes(klass) { |v| v.camelize }
+      end
+    end
+
+    module JSON
+      def as_json(*)
+        Util.as_json(self, :camelize)
+      end
+
+      def to_json(*argz)
+        as_json.to_json(*argz)
+      end
+    end
+  end
+
+  #
+  # Support +camelCase+ attributes. See Class2::SnakeCase .
+  #
+  module LowerCamelCase
+    module Attributes
+      def self.included(klass)
+        Util.convert_attributes(klass) { |v| v.camelize(:lower) }
+      end
+    end
+
+    module JSON
+      def as_json(*)
+        Util.as_json(self, :camelize, :lower)
+      end
+
+      def to_json(*argz)
+        as_json.to_json(*argz)
+      end
+    end
+  end
+
+  #
+  # Use this when the class was not defined using a Hash with +snake_case+ keys
+  # but +snake_case+ is a desired access or serialization mechanism.
+  #
+  module SnakeCase
+    #
+    # Support +snake_case+ attributes.
+    # This will accept them in the constructor and return them via #to_h.
+    #
+    # The key format used to define the class will still be accepted and its accessors will
+    # remain.
+    #
+    module Attributes
+      def self.included(klass)
+        Util.convert_attributes(klass) { |v| v.underscore }
+      end
+    end
+
+    #
+    # Create JSON documents that have +snake_case+ properties.
+    # This will add #as_json and #to_json methods.
+    #
+    module JSON
+      def as_json(*)
+        Util.as_json(self, :underscore)
+      end
+
+      def to_json(*argz)
+        as_json.to_json(*argz)
+      end
+    end
+  end
+
+  module Util
+    def self.as_json(klass, *argz)
+      hash = {}
+      klass.to_h.each do |k, v|
+        if v.is_a?(Hash)
+          v = as_json(v, *argz)
+        elsif v.is_a?(Array)
+          v = v.map { |e| as_json(e, *argz) }
+        elsif v.respond_to?(:as_json)
+          v = v.as_json
+        end
+
+        hash[k.to_s.public_send(*argz)] = v
+      end
+
+      hash
+    end
+
+    def self.convert_attributes(klass)
+      klass.class_eval do
+        new_nested = []
+        new_attributes = []
+
+        __attributes.map do |old_name|
+          new_name = yield(old_name.to_s)
+          alias_method new_name, old_name
+          alias_method "#{new_name}=", "#{old_name}="
+
+          new_attributes << new_name.to_sym
+          new_nested << new_attributes.last if __nested_attributes.include?(old_name)
+        end
+
+        class_eval <<-CODE
+          def self.__attributes
+            #{new_attributes}.freeze
+          end
+
+          # We need both styles nere to support proper assignment of nested attributes... :(
+          def self.__nested_attributes
+            #{new_nested + __nested_attributes}.freeze
+          end
+        CODE
+      end
+    end
+  end
+
+  private_constant :Util
+
 end

data/lib/class2/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Class2
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class2
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2018-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport