options_model 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbc86cf05d36942bfaedc8e5110ffde4560dec33
+  data.tar.gz: 51d723a133527412281c1751da1269cff2e6eb13
+SHA512:
+  metadata.gz: 349f91af8fe2bdc272af7fd56ba0f307a798e9bfc14b13c28216ea0ca5c07551cc6fecba7f130171e61328c84352c9415cdcd66a897b3eed276d6f4834d39b9c
+  data.tar.gz: 41fb67f98b8ca797a0a7d97985694eceadbc419dd03db1141cecf07643efd81eb9227c4e6530d8890f53ffde9a93390f015082725987e90d30a92b3a31af5349

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Jun Jiang
+
+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,56 @@
+# OptionsModel
+
+An ActiveModel implementation that make easier to handle model which will be serialized in a real model.
+
+support attribute:
+
+- all types that `ActiveModel::Type` support
+- typed array
+- enum
+- embeds one
+
+## Usage
+
+class Person < OptionsModel::Base
+  attribute :name, :string
+  attribute :age, :integer
+
+  validates :name, presence: true
+end
+
+class Book < OptionsModel::Base
+  embeds_one :author, class_name: 'Person'
+
+  attribute :title,     :string
+  attribute :tags,      :string,   array:   true
+  attribute :price,     :decimal,  default: 0
+  attribute :meta,      :json,     default: {}
+  attribute :bought_at, :datetime, default: -> { Time.new } 
+
+  validates :title, presence: true
+end
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'options_model'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+Please write unit test with your code if necessary.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OptionsModel'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/options_model.rb

@@ -0,0 +1,13 @@
+require "active_model"
+require "active_model/type"
+
+require "options_model/concerns/attribute_assignment"
+require "options_model/concerns/attributes"
+require "options_model/concerns/name_hacking"
+require "options_model/concerns/serialization"
+
+require "options_model/base"
+
+module OptionsModel
+
+end

data/lib/options_model/base.rb

@@ -0,0 +1,36 @@
+module OptionsModel
+  class Base
+    include ActiveModel::Model
+    include OptionsModel::Concerns::Serialization
+    include OptionsModel::Concerns::Attributes
+    include OptionsModel::Concerns::AttributeAssignment
+
+    validate do
+      self.class.attribute_names.each do |attribute_name|
+        attribute = public_send(attribute_name)
+        if attribute.is_a?(self.class) && attribute.invalid?
+          errors.add attribute_name, :invalid
+        end
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name}:OptionsModel #{self.to_h}>"
+    end
+
+    def self.inspect
+      "#<#{name}:OptionsModel [#{attribute_names.map(&:inspect).join(', ')}]>"
+    end
+
+    def persisted?
+      true
+    end
+
+    def self.derive(name)
+      Class.new(self) do
+        include OptionsModel::Concerns::NameHacking
+        self.name = name
+      end
+    end
+  end
+end

data/lib/options_model/concerns/attribute_assignment.rb

@@ -0,0 +1,77 @@
+module OptionsModel::Concerns
+  module AttributeAssignment
+    extend ActiveSupport::Concern
+
+    def initialize(attributes = {})
+      update_attributes(attributes)
+    end
+
+    def initialize_dup(other)
+      super
+
+      update_attributes(other)
+    end
+
+    def update_attributes(other)
+      return unless other
+
+      unless other.respond_to?(:to_h)
+        raise ArgumentError, "#{other} must be respond to `to_h`"
+      end
+
+      other.to_h.each do |k, v|
+        if respond_to?("#{k}=")
+          public_send("#{k}=", v)
+        else
+          unused_attributes[k] = v
+        end
+      end
+    end
+
+    def [](key)
+      public_send(key) if respond_to?(key)
+    end
+
+    def []=(key, val)
+      setter = "#{key}="
+      if respond_to?(setter)
+        public_send(setter, val)
+      else
+        unused_attributes[key] = val
+      end
+    end
+
+    def fetch(key, default = nil)
+      if self.class.attribute_names.exclude?(key.to_sym) && default.nil? && !block_given?
+        raise KeyError, "attribute not found"
+      end
+
+      value = respond_to?(key) ? public_send(key) : nil
+      return value if value
+
+      if default
+        default
+      elsif block_given?
+        yield
+      end
+    end
+
+    def _attributes
+      @attributes ||= ActiveSupport::HashWithIndifferentAccess.new
+    end
+    private :_attributes
+    alias_method :attributes, :_attributes
+
+    def _nested_attributes
+      @nested_attributes ||= ActiveSupport::HashWithIndifferentAccess.new
+    end
+    private :_nested_attributes
+    alias_method :nested_attributes, :_nested_attributes
+
+    def _unused_attributes
+      @unused_attributes ||= ActiveSupport::HashWithIndifferentAccess.new
+    end
+    private :_unused_attributes
+    alias_method :unused_attributes, :_unused_attributes
+  end
+end

data/lib/options_model/concerns/attributes.rb

@@ -0,0 +1,203 @@
+module OptionsModel::Concerns
+  module Attributes
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def attribute(name, cast_type, default: nil, array: false)
+        check_not_finalized!
+
+        name = name.to_sym
+        check_name_validity! name
+
+        ActiveModel::Type.lookup(cast_type)
+
+        attribute_defaults[name] = default
+
+        generated_attribute_methods.synchronize do
+          generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
+            def #{name}
+              value = attributes[:#{name}]
+              return value unless value.nil?
+              attributes[:#{name}] = self.class.attribute_defaults[:#{name}].#{default.respond_to?(:call) ? "call" : "dup"}
+              attributes[:#{name}]
+            end
+          STR
+
+          if array
+            generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
+              def #{name}=(value)
+                if value.respond_to?(:to_a)
+                  attributes[:#{name}] = value.to_a.map { |i| ActiveModel::Type.lookup(:#{cast_type}).cast(i) }
+                elsif value.nil?
+                  attributes[:#{name}] = self.class.attribute_defaults[:#{name}].#{default.respond_to?(:call) ? "call" : "dup"}
+                else
+                  raise ArgumentError,
+                        "`value` should respond to `to_a`, but got \#{value.class} -- \#{value.inspect}"
+                end
+              end
+            STR
+          else
+            generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
+              def #{name}=(value)
+                attributes[:#{name}] = ActiveModel::Type.lookup(:#{cast_type}).cast(value)
+              end
+            STR
+
+            if cast_type == :boolean
+              generated_attribute_methods.send :alias_method, :"#{name}?", name
+            end
+          end
+        end
+
+        self.attribute_names_for_inlining << name
+        name
+      end
+
+      def enum_attribute(name, enum, default: nil, allow_nil: false)
+        check_not_finalized!
+
+        unless enum.is_a?(Array) && enum.any?
+          raise ArgumentError, "enum should be an Array and can't empty"
+        end
+        enum = enum.map(&:to_s)
+
+        attribute name, :string, default: default
+
+        pluralized_name = name.to_s.pluralize
+        generated_class_methods.synchronize do
+          generated_class_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
+            def #{pluralized_name}
+              %w(#{enum.join(" ")}).freeze
+            end
+          STR
+
+          validates name, inclusion: {in: enum}, allow_nil: allow_nil
+        end
+      end
+
+      def embeds_one(name, class_name: nil, anonymous_class: nil)
+        check_not_finalized!
+
+        if class_name.blank? && anonymous_class.nil?
+          raise ArgumentError, "must provide at least one of `class_name` or `anonymous_class`"
+        end
+
+        name = name.to_sym
+        check_name_validity! name
+
+        if class_name.present?
+          nested_classes[name] = class_name.constantize
+        else
+          nested_classes[name] = anonymous_class
+        end
+
+        generated_attribute_methods.synchronize do
+          generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
+            def #{name}
+              nested_attributes[:#{name}] ||= self.class.nested_classes[:#{name}].new(attributes[:#{name}])
+            end
+          STR
+
+          generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
+            def #{name}=(value)
+              klass = self.class.nested_classes[:#{name}]
+              if value.respond_to?(:to_h)
+                nested_attributes[:#{name}] = klass.new(value.to_h)
+              elsif value.is_a? klass
+                nested_attributes[:#{name}] = value
+              elsif value.nil?
+                nested_attributes[:#{name}] = klass.new
+              else
+                raise ArgumentError,
+                      "`value` should respond to `to_h` or \#{klass}, but got \#{value.class}"
+              end
+            end
+          STR
+        end
+
+        self.attribute_names_for_nesting << name
+        name
+      end
+
+      def attribute_defaults
+        @attribute_defaults ||= ActiveSupport::HashWithIndifferentAccess.new
+      end
+
+      def nested_classes
+        @nested_classes ||= ActiveSupport::HashWithIndifferentAccess.new
+      end
+
+      def attribute_names_for_nesting
+        @attribute_names_for_nesting ||= Set.new
+      end
+
+      def attribute_names_for_inlining
+        @attribute_names_for_inlining ||= Set.new
+      end
+
+      def attribute_names
+        attribute_names_for_nesting + attribute_names_for_inlining
+      end
+
+      def finalized?
+        @finalized ||= false
+      end
+
+      def finalize!(nested = true)
+        if nested
+          nested_classes.values.each &:finalize!
+        end
+
+        @finalized = true
+      end
+
+      protected
+
+      def check_name_validity!(symbolized_name)
+        if dangerous_attribute_method?(symbolized_name)
+          raise ArgumentError, "#{symbolized_name} is defined by #{OptionsModel::Base}. Check to make sure that you don't have an attribute or method with the same name."
+        end
+
+        if attribute_names_for_inlining.include?(symbolized_name) || attribute_names_for_nesting.include?(symbolized_name)
+          raise ArgumentError, "duplicate define attribute `#{symbolized_name}`"
+        end
+      end
+
+      def check_not_finalized!
+        if finalized?
+          raise "can't modify finalized #{self}"
+        end
+      end
+
+      # A method name is 'dangerous' if it is already (re)defined by OptionsModel, but
+      # not by any ancestors. (So 'puts' is not dangerous but 'save' is.)
+      def dangerous_attribute_method?(name) # :nodoc:
+        method_defined_within?(name, OptionsModel::Base)
+      end
+
+      def method_defined_within?(name, klass, superklass = klass.superclass) # :nodoc:
+        if klass.method_defined?(name) || klass.private_method_defined?(name)
+          if superklass.method_defined?(name) || superklass.private_method_defined?(name)
+            klass.instance_method(name).owner != superklass.instance_method(name).owner
+          else
+            true
+          end
+        else
+          false
+        end
+      end
+
+      def generated_attribute_methods
+        @generated_attribute_methods ||= Module.new {
+          extend Mutex_m
+        }.tap { |mod| include mod }
+      end
+
+      def generated_class_methods
+        @generated_class_methods ||= Module.new {
+          extend Mutex_m
+        }.tap { |mod| extend mod }
+      end
+    end
+  end
+end

data/lib/options_model/concerns/name_hacking.rb

@@ -0,0 +1,19 @@
+module OptionsModel::Concerns
+  module NameHacking
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def name
+        @_name
+      end
+
+      def name=(value)
+        unless /^[A-Z][a-zA-Z_0-9]*$/ =~ value
+          raise ArgumentError, "`name` must a valid class name"
+        end
+
+        @_name = value
+      end
+    end
+  end
+end

data/lib/options_model/concerns/serialization.rb

@@ -0,0 +1,51 @@
+module OptionsModel::Concerns
+  module Serialization
+    extend ActiveSupport::Concern
+
+    def to_h
+      hash = {}
+
+      self.class.attribute_names.each do |attribute_name|
+        attribute = public_send(attribute_name)
+        if attribute.is_a?(OptionsModel::Base)
+          hash[attribute_name] = attribute.to_h
+        else
+          hash[attribute_name] = attribute
+        end
+      end
+
+      hash
+    end
+
+    def to_h_with_unused
+      to_h.merge unused_attributes
+    end
+
+    module ClassMethods
+      def dump(obj)
+        return YAML.dump({}) unless obj
+
+        unless obj.is_a? self
+          raise ArgumentError,
+                "can't dump: was supposed to be a #{self}, but was a #{obj.class}. -- #{obj.inspect}"
+        end
+
+        YAML.dump obj.to_h
+      end
+
+      def load(yaml)
+        return new unless yaml
+        return new unless yaml.is_a?(String) && /^---/.match?(yaml)
+
+        hash = YAML.load(yaml) || Hash.new
+
+        unless hash.is_a? Hash
+          raise ArgumentError,
+                "can't load: was supposed to be a #{Hash}, but was a #{hash.class}. -- #{hash.inspect}"
+        end
+
+        new hash
+      end
+    end
+  end
+end

data/lib/options_model/version.rb

@@ -0,0 +1,3 @@
+module OptionsModel
+  VERSION = "0.0.1".freeze
+end

data/lib/tasks/options_model_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :options_model do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: options_model
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jasl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: An ActiveModel implementation that make easier to handle model which
+  will be serialized in a real model.
+email:
+- jasl9187@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/options_model.rb
+- lib/options_model/base.rb
+- lib/options_model/concerns/attribute_assignment.rb
+- lib/options_model/concerns/attributes.rb
+- lib/options_model/concerns/name_hacking.rb
+- lib/options_model/concerns/serialization.rb
+- lib/options_model/version.rb
+- lib/tasks/options_model_tasks.rake
+homepage: https://github.com/jasl-lab/options_model
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Make easier to handle model which will be serialized in a real model.
+test_files: []