assignbot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef98faf3e37d5d3202cdb1a39a1296ba9be56601
+  data.tar.gz: 45e74d267458e6bed9abe74407eb24d505c7a8ae
+SHA512:
+  metadata.gz: 4c385dea04056f779e1642ee4eefa2a61094ea385a111f0874f8b656550a6fc6bd0bde6b382a7974b4be5f68112bb908d90f307fc97488f65b750a263ab0de30
+  data.tar.gz: ca21b53b96d44d4e7bcdf218454f2ea56695c0ea183e1ad92fd53a607e8c0fa3cbc1a546718782bf93b76113a06897c30fde8afcc34572946f1a328c5208db0d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.swp
+*.swo
+*.swn
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Adam Pahlevi
+
+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,85 @@
+# Assignbot
+
+In Ruby, assigning variables can be tricky. Could you assign from new? Could you always guarantee that? 
+
+Assignbot guarantee you can assign from `.assign`, code changes to your codebase is not required
+unless you want custom behaviour.
+
+[ ![Codeship Status for saveav/assignbot](https://codeship.com/projects/78f58640-581d-0133-7dbd-1ebb29223a5a/status?branch=master)](https://codeship.com/projects/109613)
+
+# Use cases
+
+1. Assign from the hash, from params
+2. Assign from the hash, from JSON
+
+## Installation
+
+To install Assignbot, add this line to your Gemfile:
+
+```ruby
+gem 'assignbot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it system-wide by issuing:
+
+    $ gem install assignbot
+
+## Usage
+
+Assume you have the following User class:
+
+```ruby
+class User
+  attr_accessor :name, :age, :id
+end
+```
+
+Basic usage of assigner does not require significant code change to your model/ruby class, other than a one-liner include statement:
+
+```ruby
+class User
+  include Assignbot
+
+  # your other ruby code
+end
+```
+
+By doing so, you already make User to be assignable from a Hash:
+
+```ruby
+user_params = {
+  name: "Adam Pahlevi",
+  age: 23,
+  id: "934-2311"
+}
+
+user = User.new
+user.assign(user_params)
+user.name == "Adam Pahlevi" # returns true
+```
+
+If you would like to explicitly tell Assignbot what are the assignable variables, then you have to define the variables explicitly:
+
+```ruby
+class User
+  include Assignbot
+
+  assigner do
+    name from: :name
+    age from: :age
+    id from: :id
+  end
+  # your other ruby code
+end
+```
+
+Explicitly defining assigner also allow you to map the value from source variable, which have different nomenclature, to the target variable in your Ruby class.
+
+## License
+
+The gem is proudly available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/assignbot.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'assignbot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'assignbot'
+  spec.version       = Assignbot::VERSION
+  spec.authors       = ['Adam Pahlevi']
+  spec.email         = ['adam.pahlevi@gmail.com']
+
+  spec.summary       = 'Automatical object assignment using hash'
+  spec.description   = "Assign an object's instance variables using hash"
+  spec.homepage      = 'https://github.com/saveav/assignbot'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'assignbot'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/assignbot.rb

@@ -0,0 +1,61 @@
+require 'assignbot/version'
+require 'assignbot/core'
+
+require 'assignbot/dsl/assigner_dsl'
+
+require 'assignbot/exceptions/unmasked_error'
+require 'assignbot/exceptions/dsl_error'
+
+require 'assignbot/foundations/assignable'
+require 'assignbot/foundations/assigner'
+require 'assignbot/foundations/variable'
+
+module Assignbot
+  def self.included(base)
+    base.extend(Assignbot::ClassDsl)
+  end
+
+  def assignbot_assign(assigner_name, hash)
+    assignable = Assignbot::Core.get_assignable(self.class)
+    assigner = assignable.get_assigner(assigner_name)
+    fail AssigningError, "Undefined assigner scope: #{assigner_name}" unless assigner_name.to_sym == :default
+
+    if assigner && assigner.variables.any?
+      # use explicitly from defined variables
+      assigner.variables.each do |_, variable_ic|
+        source_variable = variable_ic.source_variable
+        value = hash[source_variable.to_s] || hash[source_variable.to_sym]
+        send(variable_ic.receptor, value)
+      end
+    else
+      hash.each do |target_variable, value|
+        send(:"#{target_variable}=", value)
+      end
+    end
+  end
+  private :assignbot_assign
+
+  def assign(hash)
+    assignbot_assign(:default, hash)
+  end
+
+  def method_missing(name, *args, &block)
+    if name =~ /assign_/i
+      assigner_name = name.to_s.gsub(/^assign_/i, '')
+      assignbot_assign(assigner_name, args[0])
+    else
+      super(name, *args, &block)
+    end
+  end
+
+  # inner class that get extended to the base class
+  module ClassDsl
+
+    module_function
+
+    def assigner(&block)
+      assigner_dsl = AssignerDsl.new(self)
+      assigner_dsl.instance_eval(&block)
+    end
+  end
+end

data/lib/assignbot/core.rb

@@ -0,0 +1,20 @@
+module Assignbot
+  # Store Assignbot-wide static variables and functions
+  module Core
+    ASSIGNABLES = {}
+
+    module_function
+
+    def get_assignable(target_class)
+      fail DslError, 'Pass in class' unless target_class.is_a?(Class)
+      target_class_name = target_class.to_s
+
+      asclass = ASSIGNABLES[target_class_name]
+      if asclass.nil?
+        asclass = Assignable.new(target_class)
+        ASSIGNABLES[target_class_name] = asclass
+      end
+      asclass
+    end
+  end
+end

data/lib/assignbot/dsl/assigner_dsl.rb

@@ -0,0 +1,27 @@
+module Assignbot
+  # DSL class that will be instantiated on call of "assigner"
+  class AssignerDsl
+    attr_reader :target_class
+
+    def initialize(target_class)
+      @target_class = target_class
+      # assignable instance
+      @assignable_ic = Core.get_assignable(target_class)
+    end
+
+    def set(target_variable, source_variable, receptor)
+      @assignable_ic.add_variable(:default,
+                                  target_variable,
+                                  source_variable,
+                                  receptor)
+    end
+
+    def method_missing(name, *args)
+      params = args[0]
+      fail DslError, 'Put in hash as an argument!' unless params.is_a?(Hash)
+      
+      source_variable = params[:from] || params['from']
+      set(name, source_variable, :"#{source_variable}=")
+    end
+  end
+end

data/lib/assignbot/exceptions/assigning_error.rb

@@ -0,0 +1,4 @@
+module Assignbot
+  class AssigningError < UnmaskedError
+  end
+end

data/lib/assignbot/exceptions/dsl_error.rb

@@ -0,0 +1,5 @@
+module Assignbot
+  class DslError < UnmaskedError
+
+  end
+end

data/lib/assignbot/exceptions/unmasked_error.rb

@@ -0,0 +1,5 @@
+module Assignbot
+  # error that does not need to be masked as other error
+  class UnmaskedError < StandardError
+  end
+end

data/lib/assignbot/foundations/assignable.rb

@@ -0,0 +1,46 @@
+module Assignbot
+  # assignable represent the class, it has many assigner
+  class Assignable
+    # all instances of assigners, type: Hash
+    attr_reader :assigners
+    # the target class of it
+    attr_reader :target_class
+
+    def initialize(target_class)
+      @target_class = target_class
+      @assigners = {}
+    end
+
+    def add_assigner(assigner)
+      assigner_name = Assigner.canonify_name(assigner.name)
+      assigners[assigner_name] = assigner
+      nil
+    end
+
+    def get_assigner(assigner_name)
+      assigner = assigners[Assigner.canonify_name(assigner_name)]
+      assigner
+    end
+
+    def add_variable(assigner_name,
+                     target_variable,
+                     source_variable,
+                     receptor)
+
+      # create one instance of Assigner unless defined
+      assigner = get_assigner(assigner_name)
+      if assigner.nil?
+        assigner = Assigner.new(self, assigner_name)
+        add_assigner(assigner)
+      end
+
+      variable = Variable.new(assigner)
+      variable.target_variable = target_variable
+      variable.source_variable = source_variable
+      variable.receptor = receptor
+      assigner.add_variable(variable)
+
+      nil
+    end
+  end
+end

data/lib/assignbot/foundations/assigner.rb

@@ -0,0 +1,33 @@
+module Assignbot
+  # assignable has many assigner, the default
+  # assigner is named :default. one can design assigner from
+  # params which is from JSON, or from XML. if unnamed,
+  # then use :default as name
+  class Assigner
+    attr_reader :assignable
+    attr_reader :name
+    # all variables, based on target_variable
+    attr_reader :variables
+
+    def self.canonify_name(name)
+      unless name.is_a?(String) || name.is_a?(Symbol)
+        fail DslError, "Name must be either symbol or string, got: #{name}" 
+      end
+      name.to_s.downcase.tr(' ', '_').to_sym
+    end
+
+    def initialize(assignable, assigner_name)
+      @assignable = assignable
+      @name = assigner_name
+      @variables = {}
+    end
+
+    def get_variable(target_variable)
+      @variables[target_variable]
+    end
+
+    def add_variable(variable)
+      @variables[variable.target_variable] = variable
+    end
+  end
+end

data/lib/assignbot/foundations/variable.rb

@@ -0,0 +1,18 @@
+module Assignbot
+  # represent the variable both from target, and from source; and through which 
+  # method the value from source can be copied to target
+  class Variable
+    attr_reader :assigner
+
+    # the variable to which the value will be copied to
+    attr_accessor :target_variable
+    attr_accessor :source_variable
+
+    # receptor, receive value
+    attr_accessor :receptor
+
+    def initialize(assigner)
+      @assigner = assigner
+    end
+  end
+end

data/lib/assignbot/version.rb

@@ -0,0 +1,4 @@
+# our Assignbot gem
+module Assignbot
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: assignbot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Pahlevi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Assign an object's instance variables using hash
+email:
+- adam.pahlevi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assignbot.gemspec
+- bin/console
+- bin/setup
+- lib/assignbot.rb
+- lib/assignbot/core.rb
+- lib/assignbot/dsl/assigner_dsl.rb
+- lib/assignbot/exceptions/assigning_error.rb
+- lib/assignbot/exceptions/dsl_error.rb
+- lib/assignbot/exceptions/unmasked_error.rb
+- lib/assignbot/foundations/assignable.rb
+- lib/assignbot/foundations/assigner.rb
+- lib/assignbot/foundations/variable.rb
+- lib/assignbot/version.rb
+homepage: https://github.com/saveav/assignbot
+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.5
+signing_key: 
+specification_version: 4
+summary: Automatical object assignment using hash
+test_files: []
+has_rdoc: