transient-model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4834b578d0f364eb5db665ec3801d3d1601cca30
+  data.tar.gz: 2909d3c25af1fb60f5ddeaa00f3c9c3986edd9c7
+SHA512:
+  metadata.gz: 6b49fbbc0fc4d60330b49477f2a78fe42f0f927292c69ea8c16041c0d4616c17d84b9dab007539c2725f5c6d12891d3960ca5d740f2de34d0811b14890aaece8
+  data.tar.gz: 0206f69d925d1ecf5baa99532300a6ab1f9c712f213144cd8f8b03d26df35a14498bbb89d71739d825c15344bddaa2f616425575b7a425325db8285fd9726df1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.irbrc

@@ -0,0 +1 @@
+require 'irbtools'

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+transient-model

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+# Transient::Model
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/transient/model`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'transient-model'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transient-model
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/transient-model.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "transient/model"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/transient_model/base.rb

@@ -0,0 +1,40 @@
+# lib/transient_model/base.rb
+
+require "transient_model/version"
+require "transient_model/dsl"
+require "transient_model/fields"
+
+module TransientModel
+  class MissingField < StandardError; end
+
+  class Base
+    include ActiveModel::Model
+    include TransientModel::Dsl::Fields
+    # include ActiveModel::Dirty
+    # extend ActiveSupport::Callbacks
+
+    def initialize(attributes = {})
+      hydrate_attributes attributes
+    end
+
+    private # ---------------------------------------------
+
+    def hydrate_attributes(attributes = {})
+      hydrate_attributes! attributes
+    rescue TransientModel::MissingField
+      false
+    end
+
+    def hydrate_attributes!(attributes = {})
+      attributes.each do |key, value|
+        setter_method_name = "#{ key }=".to_sym
+
+        if self.respond_to?(setter_method_name)
+          self.send(setter_method_name, value)
+        else
+          raise MissingField, "the field #{ key } was not found."
+        end
+      end
+    end
+  end
+end

data/lib/transient_model/dsl/fields.rb

@@ -0,0 +1,123 @@
+# lib/transient/model/dsl/fields.rb
+
+module TransientModel
+  module Dsl
+    module Fields
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :fields
+        self.fields = {}
+      end
+
+      module ClassMethods
+        # Add a field to your model.
+        #
+        # @example field :first_name
+        #
+        # @param [ String ] name
+        # @param [ Hash ] options
+        #
+        # @return [ Field ] the field added to the model.
+        # @since 0.1.0
+        ##
+        def field(name, options = {})
+          field_name = name.to_s
+          define_field(field_name, options)
+        end
+
+        protected # -------------------------------------
+
+        # Add the new field to the class definition.
+        #
+        # @example
+        #
+        # @param [ String ] name - The name of the field you are adding.
+        # @param [ Hash ] options - The options to be used by this field.
+        #
+        # @return [ TransientModel::Fields::Base ] the field generated
+        # @since 0.1.0
+        ##
+        def define_field(name, options = {})
+          field = field_for(name, options)
+          fields[name.to_sym] = field
+          create_accessors name, options
+          field
+        end
+
+        # Create the getter & setter accessors for the field defined.
+        #
+        # @param [ Field ] field - The field we are created accessors for.
+        #
+        # @return [ Boolean ]
+        # @since 0.1.0
+        ##
+        def create_accessors(name, options)
+          field = fields[name.to_sym]
+          create_field_getter(field)
+          create_field_setter(field)
+        end
+
+        # Generate a setter method for setting the field value.
+        #
+        # @since 0.1.0
+        ##
+        def create_field_setter(field)
+          generated_methods.module_eval do
+            define_method(field.setter_method_name) do |value|
+              current_value = instance_variable_get(field.instance_variable_name)
+
+              # Commenting out until I have time to add dirty tracking.
+              #
+              # self.send "#{ field.name }_will_change!" unless current_value == value
+
+              instance_variable_set(field.instance_variable_name, value)
+            end
+          end
+        end
+
+        # Generate a getter method for the data object.
+        #
+        # @return []
+        # @since 0.1.0
+        ##
+        def create_field_getter(field)
+          generated_methods.module_eval do
+            define_method(field.getter_method_name) do
+              _value = instance_variable_get field.instance_variable_name
+              _value.blank? ? field.default_value : _value
+            end
+          end
+        end
+
+        # We are going to dynamically build all of our setters/getter in a
+        # module that will then be included into the implementing class.
+        #
+        # @return [ Module ] returns the module that was generated.
+        # @since 0.1.0
+        ##
+        def generated_methods
+          @generated_methods ||= begin
+            _module = Module.new
+            include(_module)
+            _module
+          end
+        end
+
+        # Dynamically load up the proper field type
+        #
+        # @param [ String ] name - The name of the field you are creating.
+        # @param [ Hash ] options - The options to be used.
+        #
+        # @return [ Field ] The field definition
+        # @since 0.1.0
+        ##
+        def field_for(name, options)
+          options.merge!(klass: self)
+          TransientModel::Fields::StandardField.new name, options
+        end
+      end
+
+    end
+  end
+end

data/lib/transient_model/dsl.rb

@@ -0,0 +1,9 @@
+# lib/transient/model/dsl.rb
+
+require 'transient_model/dsl/fields'
+
+module TransientModel
+  module Dsl
+
+  end
+end

data/lib/transient_model/fields/base_field.rb

@@ -0,0 +1,61 @@
+# lib/transient_model/fields/base_field.rb
+
+module TransientModel
+  module Fields
+    class BaseField
+      attr_accessor :name, :options
+
+      # Initialize a new field object
+        #
+        # @param [ String ] name
+        # @param [ Hash ] options
+        #
+        # @since 0.1.0
+        ##
+        def initialize(name, options = {})
+          defaults = {
+            type: String
+          }
+
+          @name = name
+          @options = defaults.merge options
+        end
+
+        # Return the default value that should be used for the field.
+        #
+        # @return [ any ] returns the default value set for the field.
+        # @since 0.1.0
+        ##
+        def default_value
+          @options.fetch(:default, nil)
+        end
+
+        # Return the data type for this field.
+        #
+        # @return [ any ]
+        # @since 0.1.0
+        ##
+        def type
+          @type ||= options.fetch(:type, String)
+        end
+
+        # Return the symbol representation of the instance variable
+        # used by the defining model object.
+        #
+        # @return [ Symbol ] the instance variable name of the field
+        # @since 0.1.0
+        ##
+        def instance_variable_name
+          "@#{ @name }".to_sym
+        end
+
+        def getter_method_name
+          "#{ @name }".to_sym
+        end
+
+        def setter_method_name
+          "#{ @name }=".to_sym
+        end
+    end
+  end
+end

data/lib/transient_model/fields/standard_field.rb

@@ -0,0 +1,9 @@
+# lib/transient_model/fields/standard_field.rb
+
+module TransientModel
+  module Fields
+    class StandardField < TransientModel::Fields::BaseField
+
+    end
+  end
+end

data/lib/transient_model/fields.rb

@@ -0,0 +1,10 @@
+# lib/transient_model/fields.rb
+
+require 'transient_model/fields/base_field'
+require 'transient_model/fields/standard_field'
+
+module TransientModel
+  module Fields
+
+  end
+end

data/lib/transient_model/version.rb

@@ -0,0 +1,5 @@
+# lib/transient_model/version.rb
+
+module TransientModel
+  VERSION = "0.1.0"
+end

data/lib/transient_model.rb

@@ -0,0 +1,9 @@
+# lib/transient_model.rb
+
+require "active_model"
+require 'transient_model/version'
+require 'transient_model/base'
+
+module TransientModel
+
+end

data/transient-model.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transient_model/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transient-model"
+  spec.version       = TransientModel::VERSION
+  spec.authors       = ["JD Hendrickson"]
+  spec.email         = ["jd@digitalopera.com"]
+
+  spec.summary       = %q{Provides a simple DSL for defining non-persistent models}
+  spec.description   = %q{Provides a simple DSL for defining non-persistent models}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov",    "~> 0.11.1"
+  spec.add_development_dependency "irbtools"
+  spec.add_development_dependency "byebug"
+
+  spec.add_dependency 'activemodel',    '>= 4.0.0', '< 6.0.0'
+  spec.add_dependency 'activesupport',  '>= 4.0.0', '< 6.0.0'
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: transient-model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JD Hendrickson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: irbtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: Provides a simple DSL for defining non-persistent models
+email:
+- jd@digitalopera.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".irbrc"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/transient_model.rb
+- lib/transient_model/base.rb
+- lib/transient_model/dsl.rb
+- lib/transient_model/dsl/fields.rb
+- lib/transient_model/fields.rb
+- lib/transient_model/fields/base_field.rb
+- lib/transient_model/fields/standard_field.rb
+- lib/transient_model/version.rb
+- transient-model.gemspec
+homepage: 
+licenses: []
+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.1
+signing_key: 
+specification_version: 4
+summary: Provides a simple DSL for defining non-persistent models
+test_files: []