model_pack 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fedf28243c4c586d1ef06698fc4a7e41615eb82a
+  data.tar.gz: 1d895d036f7f44226f8ffbd2a0f9f98696ae4862
+SHA512:
+  metadata.gz: 0a9317d03361f697ff4f0a7bae3a6656f5d7573a7adbe7093a4713c1c04d5f72c20b8db5bf24a0d5cb6af43731b11109f2bdb5b87bac1b32a7337b3b3889a7e2
+  data.tar.gz: a9b1963cf12b3f612dc0098ce5c90889bbde5b4495755b8c9c6fcb3ff68578d87f768582cae6e178a143b584339d5489b359c36139dd296c7f21e0f5af1c6024

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in model_pack.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 che
+
+MIT License
+
+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,47 @@
+# Model Pack - model intefaces
+
+Model Pack - набор интерфейсов, который позволяет создавать в объекте специальные аттрибуты.
+Также добавляет методы работы model attributes. Прозволяет сериализировать иерахнию модельных
+аттрибутов.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'model_pack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install model_pack
+
+## Usage
+
+```ruby
+class Point
+  include ModelPack::Document
+
+  attribute :x
+  attribute :y
+end
+
+class Line
+  include ModelPack::Document
+
+  object :begin, class_name: Point
+  object :end, class_name: Point
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/chelovekov/model_pack/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/model_pack/attribute_methods.rb

@@ -0,0 +1,37 @@
+module ModelPack
+  module AttributeMethods
+    extend Concern
+
+    class_methods do
+      def register_attribute(name)
+        raise ArgumentError, "dublicate attribute with name `#{name}`" if attribute_names.include?(name)
+        attribute_names.push name
+        nil
+      end
+
+      def attribute_names
+         class_variable_defined?(:@@attribute_names) ? class_variable_get(:@@attribute_names) : class_variable_set(:@@attribute_names, Array.new)
+      end
+    end
+
+    def attributes
+      self.class.attribute_names.inject({}) { |h, name| h[name] = send(name); h  }
+    end
+
+    def update_attributes(*attributes)
+      attributes.each do |name, attribute|
+        key = "#{name}="
+        send(key, attribute) if respond_to?(key)
+      end
+    end
+
+    def update_attributes!(*attributes)
+      # check present first
+      attributes.each do |name, attribute|
+        raise ArgumentError, "undefined attribute `#{name}`" unless attribute_names.include?(method)
+        key = "#{name}="
+        send(key, attribute) if respond_to?(key)
+      end
+    end
+  end
+end

data/lib/model_pack/class_methods.rb

@@ -0,0 +1,51 @@
+module ModelPack
+  module ClassMethods
+
+    def attribute(name, writer: lambda { |v| v }, default: nil, as: nil, serialize: nil)
+      attribute_reader(name, default: default, as: as, serialize: serialize)
+      attribute_writer(name, writer: writer)
+      register_attribute(name)
+    end
+
+    def attribute_writer(name, writer: lambda { |v| v })
+      define_method "#{name}=" do |value|
+        instance_variable_set("@#{name}", instance_exec(value, &writer))
+      end
+    end
+
+    def attribute_reader(name, default: nil, as: nil, serialize: nil)
+      default_dup = default.dup rescue default
+      default_value = default_dup || (as && as.new)
+
+      define_method name do
+        instance_variable_defined?("@#{name}") ? instance_variable_get("@#{name}") : instance_variable_set("@#{name}", default_value)
+      end
+
+      define_method "#{name}_hash" do
+        instance_exec(send(name), &serialize)
+      end if serialize
+    end
+
+    def object(name, class_name: nil, default: nil, serialize: nil)
+      attribute(name,
+        default: default,
+        serialize: serialize,
+        writer: lambda { |v| v.is_a?(Hash) && class_name ? class_name.new(v) : v })
+    end
+
+    def array(name, default: nil, serialize: nil, writer: nil, class_name: nil)
+      attribute(name,
+          default: default,
+          serialize: serialize,
+          as: Array,
+          writer: writer || lambda { |array| array.collect { |v| v.is_a?(Hash) && class_name ? class_name.new(v) : v } })
+    end
+
+    def hashable(name, default: nil, serialize: nil)
+      attribute(name,
+          default: default,
+          serialize: serialize,
+          as: Hash)
+    end
+  end
+end

data/lib/model_pack/concern.rb

@@ -0,0 +1,46 @@
+module ModelPack
+  # Copy&paste from rails/activesupport/lib/active_support/concern.rb
+
+  module Concern
+    class MultipleIncludedBlocks < StandardError #:nodoc:
+      def initialize
+        super "Cannot define multiple 'included' blocks for a Concern"
+      end
+    end
+
+    def self.extended(base) #:nodoc:
+      base.instance_variable_set(:@_dependencies, [])
+    end
+
+    def append_features(base)
+      if base.instance_variable_defined?(:@_dependencies)
+        base.instance_variable_get(:@_dependencies) << self
+        return false
+      else
+        return false if base < self
+        @_dependencies.each { |dep| base.send(:include, dep) }
+        super
+        base.extend const_get(:ClassMethods) if const_defined?(:ClassMethods)
+        base.class_eval(&@_included_block) if instance_variable_defined?(:@_included_block)
+      end
+    end
+
+    def included(base = nil, &block)
+      if base.nil?
+        raise MultipleIncludedBlocks if instance_variable_defined?(:@_included_block)
+
+        @_included_block = block
+      else
+        super
+      end
+    end
+
+    def class_methods(&class_methods_module_definition)
+      mod = const_defined?(:ClassMethods) ?
+        const_get(:ClassMethods) :
+        const_set(:ClassMethods, Module.new)
+
+      mod.module_eval(&class_methods_module_definition)
+    end
+  end
+end

data/lib/model_pack/constructor.rb

@@ -0,0 +1,9 @@
+module ModelPack
+  module Constructor
+    def initialize(*a)
+      attributes = a.pop
+      update_attributes(*attributes) if attributes
+      super(*a)
+    end
+  end
+end

data/lib/model_pack/document.rb

@@ -0,0 +1,13 @@
+module ModelPack
+  module Document
+    extend Concern
+
+    included do
+      extend ClassMethods
+      include AttributeMethods
+      prepend Constructor
+      include Serialization
+      include Serializers::JSON
+    end
+  end
+end

data/lib/model_pack/serialization.rb

@@ -0,0 +1,67 @@
+module ModelPack
+  module Serialization
+
+    def serializable_attribute_names(attributes, options)
+      names = attributes.keys.sort
+      case options
+        when Hash
+          names &= Array.wrap(options.keys).map(&:to_s)
+        when true
+          # do nothing
+        when false
+          names = {}
+        when nil
+          names = {}
+      else
+        names &= Array.wrap(options).map(&:to_s)
+      end
+
+      names
+    end
+
+    def serializable_hash(options = nil, global = nil)
+      serializable_value =
+        ->(value, *a) { value.respond_to?(:serializable_hash) ? value.serializable_hash(*a[0...value.method(:serializable_hash).arity]) : value }
+      enumerable_value = ->(value, *a) {
+        value.is_a?(Hash) ? value.inject({}) { |h, e| h[e.first] = serializable_value[e.last, *a]; h } :
+        (value.is_a?(Enumerable) ? value.map{ |v| serializable_value[v, *a] } : serializable_value[value, *a])
+      }
+
+      hash = {}
+      options = Hash[*options.map{|v| [v, true]}.flatten(2)] if options.is_a?(Array)
+      self.class.attribute_names.each do |n|
+        opts = options ? options[n] : nil
+        empty = options.nil? || options.empty?
+        n_hash = "#{n}_hash"
+        if (opts || empty) && respond_to?(n_hash)
+          value = send(n_hash, *(method(n_hash).arity.zero? ? [] : [opts, global]))
+          hash[n] = value if value
+          next
+        end
+
+        value =  send(n)
+        data = case opts
+        when Symbol
+          value.send(opts)
+        when true
+          enumerable_value[value, nil, global]
+        when false
+          nil
+        when nil
+          # auto detect value type if options nil too
+          empty ? enumerable_value[value, nil, global] : nil
+        when Hash
+          enumerable_value[value, opts, global]
+        end
+        hash[n] = data if data
+      end
+      hash
+    end
+
+    def copy
+      self.class.new(self.serializable_hash)
+    end
+
+    #<<<
+  end
+end

data/lib/model_pack/serializers/json.rb

@@ -0,0 +1,13 @@
+require 'json'
+
+module ModelPack
+  module Serializers::JSON
+    def to_json
+      as_json.to_json
+    end
+
+    def as_json(options=nil)
+      serializable_hash(options)
+    end
+  end
+end

data/lib/model_pack/version.rb

@@ -0,0 +1,3 @@
+module ModelPack
+  VERSION = "0.9.0"
+end

data/lib/model_pack.rb

@@ -0,0 +1,14 @@
+require "model_pack/version"
+
+module ModelPack
+  autoload :AttributeMethods, 'model_pack/attribute_methods'
+  autoload :ClassMethods,     'model_pack/class_methods'
+  autoload :Concern,          'model_pack/concern'
+  autoload :Constructor,      'model_pack/constructor'
+  autoload :Document,         'model_pack/document'
+  autoload :Serialization,    'model_pack/serialization'
+
+  module Serializers
+    autoload :JSON,           'model_pack/serializers/json'
+  end
+end

data/model_pack.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'model_pack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "model_pack"
+  spec.version       = ModelPack::VERSION
+  spec.authors       = ["che"]
+  spec.email         = ["chelovekov@gmail.com"]
+  spec.summary       = %q{Model Pack – simple model interfaces.}
+  #spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+end

data/spec/model_pack_spec.rb

@@ -0,0 +1,139 @@
+require "spec_helper"
+
+describe ModelPack::ClassMethods do
+
+  it "should create model with default fields" do
+    class Point
+      include ModelPack::Document
+
+      attribute :x, default: 0
+      attribute :y, default: 0
+    end
+
+    point = Point.new
+    expect(point.x).to be(0)
+    expect(point.y).to be(0)
+    expect(point.attributes).to include({x: 0, y: 0})
+  end
+
+  it "should create model and fill it thought initialization" do
+    point = Point.new(x: 3, y: 5)
+    expect(point.x).to be(3)
+    expect(point.y).to be(5)
+    expect(point.attributes).to include({x: 3, y: 5})
+  end
+
+  it "should create embedded models" do
+    class Line
+      include ModelPack::Document
+
+      object :from, class_name: Point
+      object :to, class_name: Point
+
+      def length
+         Math.sqrt((from.x-to.x)**2 + (from.y-to.y)**2)
+      end
+    end
+
+    line = Line.new({
+        from: { x: 1, y: 1 },
+        to: { x: 3, y: 5}
+    })
+    expect(line.from).to be_a(Point)
+    expect(line.to).to be_a(Point)
+    expect(line.from.attributes).to include({x: 1, y: 1})
+    expect(line.to.attributes).to include({x: 3, y: 5})
+    expect(line.length).to be_within(0.1).of(4.4)
+  end
+
+  it "should create array of models" do
+    class Polygon
+      include ModelPack::Document
+
+      array :points, class_name: Point
+
+      def sides
+        return [] if points.size < 2
+        [[points.first]].tap do |sides|
+          (1...(points.size)).to_a.each do |index|
+            sides.last.push points[index]
+            sides.push [points[index]]
+          end
+          sides.last.push(points.first)
+        end
+      end
+
+      def perimeter
+        sides.inject(0) { |sum, side| sum + Math.sqrt((side[0].x-side[1].x)**2 + (side[0].y-side[1].y)**2) }
+      end
+    end
+
+    polygon = Polygon.new(points: [{x: 0, y: 0}, {x:5, y:0}, {x:5, y:5}])
+    expect(polygon.perimeter).to be_within(0.1).of(17.0)
+  end
+
+  it "should serialize model to hash" do
+    polygon = Polygon.new(points: [{x: 0, y: 0}, {x:5, y:0}, {x:5, y:5}])
+    json = polygon.as_json()
+    expect(json).to include(:points)
+    expect(json[:points]).to be_a(Array)
+    expect(json[:points][0]).to include({x: 0, y:0})
+    expect(json[:points][1]).to include({x: 5, y:0})
+    expect(json[:points][2]).to include({x: 5, y:5})
+  end
+
+  it "should serialize model with custom serializer" do
+    class SecureData
+      include ModelPack::Document
+
+      attribute :hidden_field, writer: lambda { |v| nil }
+      attribute :const_field, writer: lambda { |v| :always_this }
+      attribute :always_string, writer: lambda { |v| v.to_s }
+    end
+
+    secure_data = SecureData.new( hidden_field: "secured text", const_field: :some_value, always_string: 55)
+    unsecure_hash = secure_data.serializable_hash
+    expect(unsecure_hash).not_to include(:hidden_field)
+    expect(unsecure_hash).to include(const_field: :always_this)
+    expect(unsecure_hash).to include(always_string: "55")
+  end
+
+  it "should serialize and load back model" do
+    polygon = Polygon.new(points: [{x: 3, y: 3}, {x:2, y:1}, {x:4, y:2}])
+    polygon_copy = Polygon.new(polygon.serializable_hash) # or as_json
+    expect(polygon_copy.points).to be_a(Array)
+    polygon.points.each_with_index do |point, index|
+      expect(polygon_copy.points[index].attributes).to include(point.attributes)
+    end
+  end
+
+  it "should create copy of model" do
+    polygon = Polygon.new(points: [{x: 3, y: 3}, {x:2, y:1}, {x:4, y:2}])
+    polygon_copy = polygon.copy
+    polygon.points.each_with_index do |point, index|
+      expect(polygon_copy.points[index].attributes).to include(point.attributes)
+    end
+  end
+
+  it "should model have hashable field" do
+    class Options
+      include ModelPack::Document
+
+      hashable :options
+
+      def method_missing(name, *a)
+        options[name]
+      end
+    end
+
+    options = Options.new(options: { a: 5, b: 6 })
+
+    expect(options.a).to be(5)
+    expect(options.b).to be(6)
+  end
+
+  it "should serialize model with custom serializer" do
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require File.expand_path("./lib/model_pack")
+
+RSpec.configure do |config|
+  config.color = true
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: model_pack
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- che
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email:
+- chelovekov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/model_pack.rb
+- lib/model_pack/attribute_methods.rb
+- lib/model_pack/class_methods.rb
+- lib/model_pack/concern.rb
+- lib/model_pack/constructor.rb
+- lib/model_pack/document.rb
+- lib/model_pack/serialization.rb
+- lib/model_pack/serializers/json.rb
+- lib/model_pack/version.rb
+- model_pack.gemspec
+- spec/model_pack_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Model Pack – simple model interfaces.
+test_files:
+- spec/model_pack_spec.rb
+- spec/spec_helper.rb