object_state 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b954a8472c703394a859740677330050ca02f5af
+  data.tar.gz: a501a9e2030d067cc173c1b9cbd93cd2e41fc0ef
+SHA512:
+  metadata.gz: 3b6ec2625a2c7edec5cf64e22470827ef9f868ae0e823466ec099dfb8b9459d1c5ee793da5654c2ca0da7cbaad51e87a182903bfaf875bf31e09644e89a43bb5
+  data.tar.gz: 2f37413a9e6f788bf0364c70cfe1d186f6d80b51df9b88baad7099ecb59520b985b6f30acfb637891f14cb276d883e1f712d63275c512312d5434ab9909dccbe

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+script: 'bundle exec rake'
+rvm:
+  - 2.2.5
+before_install:
+  - gem install bundler -v 1.12.5
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^lib/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$})                       { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tomas Celizna
+
+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,142 @@
+# Object State
+
+[![Build Status](https://travis-ci.org/tomasc/object_state.svg)](https://travis-ci.org/tomasc/object_state) [![Gem Version](https://badge.fury.io/rb/object_state.svg)](http://badge.fury.io/rb/object_state) [![Coverage Status](https://img.shields.io/coveralls/tomasc/object_state.svg)](https://coveralls.io/r/tomasc/object_state)
+
+This gem helps to encapsulate state of objects of (typically) Ruby on Rails applications.
+
+* The state becomes easy to identify in the source code.
+* There is a standard method for converting the state to and from query params.
+* The state can be expressed in the form of a `cache_key`.
+* It is possible to additionally typecast and/or validate its attributes.
+
+Useful for pagination, filtering etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'object_state'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install object_state
+```
+
+## Usage
+
+### Encapsulate object's state
+
+```ruby
+class MyObj
+  include ObjectState::Owner
+
+  object_state do
+    attr_accessor :current_date
+  end
+end
+```
+
+### Export state hash
+
+```ruby
+my_obj.to_object_state_hash # => { my_obj => { id: "123", current_date: "2016-08-27" } }
+```
+
+This hash can be easily used as query params, for example:
+
+```ruby
+my_obj_path(my_obj, my_obj.to_object_state_hash)
+```
+
+An attribute can be easily overridden:
+
+```ruby
+my_obj_path(my_obj, my_obj.to_object_state_hash(current_date: Date.tomorow))
+```
+
+### Assign values from state hash
+
+```ruby
+my_obj.assign_attributes_from_object_state_hash(…)
+```
+
+The attributes will be assigned only if the id in the state hash matches the id of your object. This is helpful for example when used in controllers.
+
+## Supported attribute definitions
+
+* PoRo (`attr_accessor`)
+* Mongoid fields
+* Virtus attributes
+
+## Advanced usage
+
+Optionally the state can be processed by a custom class. This is useful when the values need to be typecast, validated, or transformed. The `ObjectState::State` includes `ActiveModel::Model` and `Virtus` so you can use [Virtus' attribute definition](https://github.com/solnic/virtus) and [ActiveModel validations](http://api.rubyonrails.org/classes/ActiveModel/Validations.html). For example:
+
+```ruby
+class MyObj::State < ObjectState::State
+  attribute :current_date, Date
+
+  validates :current_date, inclusion: { in: Date.today..Date.tomorrow }, presence: true
+end
+```
+
+Only valid values will be assigned to your object.
+
+```ruby
+class MyObj
+  include ObjectState::Owner
+
+  object_state class_name: 'MyObj::State' do
+    attr_accessor :current_date
+  end
+end
+```
+
+## Cache
+
+Often values or views associated with the object need to be cached (and the cache expired) depending on its state. The `:object_state_cache_key` generates a cache key based on the state's values. For example the `MyObj` from the above example:
+
+```ruby
+my_obj.object_state_cache_key # => '2016-08-27'
+```
+
+In fact the `object_state` method automatically merges the state object's cache key with the object's cache_key:
+
+```ruby
+my_obj.cache_key # => '<object-cache-key>/2016-08-27'
+```
+
+This can be disabled as follows:
+
+```ruby
+class MyObj
+  include ObjectState::Owner
+
+  object_state merge_cache_key: false do
+    attr_accessor :current_date
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/tomasc/object_state>.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "object_state"
+
+# 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/object_state/owner.rb

@@ -0,0 +1,45 @@
+require 'active_support/concern'
+
+module ObjectState
+  module Owner
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def object_state_class
+        @object_state_class ||= Class.new(ObjectState::State)
+      end
+
+      def object_state(options = {}, &block)
+        cls = self
+        class_name = options.fetch(:class_name, nil)
+        @object_state_class ||= class_name ? class_name.constantize : Class.new(ObjectState::State)
+        @object_state_class.class_eval do
+          setup_attributes cls, &block
+        end
+
+        if instance_methods.include?(:cache_key) && options.fetch(:merge_cache_key, true)
+          define_method :cache_key do |*args|
+            return super(*args) unless object_state
+            [super(*args), object_state.cache_key].reject(&:blank?).join('/')
+          end
+        end
+      end
+    end
+
+    def object_state(attrs = {})
+      self.class.object_state_class.new(self, attrs)
+    end
+
+    def to_object_state_hash(attrs = {})
+      object_state(attrs).try(:to_hash)
+    end
+
+    def assign_attributes_from_state_hash(attrs)
+      key = respond_to?(:model_name) ? model_name.singular : self.class.to_s.underscore
+      return unless model_attrs = attrs.stringify_keys[key]
+      model_id = model_attrs.stringify_keys['id'] || model_attrs.stringify_keys['_id']
+      return if respond_to?(:id) && model_id.to_s != id.to_s
+      object_state(model_attrs.except(*%i(_id id))).try(:update_model!)
+    end
+  end
+end

data/lib/object_state/state.rb

@@ -0,0 +1,104 @@
+require 'active_model'
+require 'virtus'
+
+module ObjectState
+  class State
+    class UnsupportedAttributeType < StandardError; end
+
+    include ActiveModel::Model
+    include ActiveSupport::Rescuable
+    include Virtus.model(nullify_blank: true)
+
+    attr_accessor :model
+
+    validates :model, presence: true
+
+    def self.attribute_names
+      attribute_set.map(&:name)
+    end
+
+    def self.setup_attributes(owner_class, &block)
+      temp_class = Class.new(Object)
+
+      # override attr_accessor to collect attr_accessor :names
+      temp_class.define_singleton_method :attr_accessor do |*names|
+        @attr_accessor_names ||= []
+        @attr_accessor_names.concat Array(names)
+        super(*names)
+      end
+
+      temp_class.define_singleton_method :attr_accessor_names do
+        Array(@attr_accessor_names)
+      end
+
+      is_mongoid_document = !!defined?(::Mongoid::Document) && owner_class.ancestors.include?(::Mongoid::Document)
+      is_virtus_model = owner_class.respond_to?(:attribute_set) # FIXME: is there a better way to check for virtus?
+
+      temp_class.class_eval do
+        include ::Mongoid::Document if is_mongoid_document
+        include Virtus.model if is_virtus_model
+        instance_eval(&block)
+      end
+
+      # setup attributes for :attr_accessor names
+      excluded_attr_accessor_names = %i(validation_context _index before_callback_halted)
+      (temp_class.attr_accessor_names - excluded_attr_accessor_names).each do |name|
+        next if attribute_set.map(&:name).include?(name.to_sym)
+        attribute name
+      end
+
+      # setup attributes for Mongoid fields
+      if is_mongoid_document
+        temp_class.fields.except(*%w(_id)).each do |name, field|
+          next if attribute_set.map(&:name).include?(name.to_sym)
+          attribute name, field.type
+        end
+      end
+
+      # setup attributes for Virtus attributes
+      if is_virtus_model
+        temp_class.attribute_set.each do |att|
+          next if attribute_set.map(&:name).include?(att.name.to_sym)
+          attribute att.name, att.type
+        end
+      end
+
+      owner_class.class_eval(&block)
+    end
+
+    def initialize(model, attrs = {})
+      self.model = model
+      super attributes_from_model.merge(attrs)
+    end
+
+    def update_model!(options = {})
+      return unless model.present?
+      return unless valid? || options[:skip_validations] == true
+      attributes.except(:id).each do |name, value|
+        model.send("#{name}=", value) if model.respond_to?(name)
+      end
+    end
+
+    def to_hash(attrs = {})
+      return unless model.present?
+      key = model.respond_to?(:model_name) ? model.model_name.singular : model.class.to_s.underscore
+      value = super()
+      value = value.merge(id: model.id) if model.respond_to?(:id)
+      value = value.merge(attrs)
+      { key => value }
+    end
+
+    def cache_key
+      attributes.values.flatten.map(&:to_s).reject(&:blank?).join('/')
+    end
+
+    private
+
+    def attributes_from_model
+      self.class.attribute_names.each_with_object({}) do |name, res|
+        res[name] = model.send(name) if model.respond_to?(name)
+        res
+      end
+    end
+  end
+end

data/lib/object_state/version.rb

@@ -0,0 +1,3 @@
+module ObjectState
+  VERSION = '0.1.0'.freeze
+end

data/lib/object_state.rb

@@ -0,0 +1,4 @@
+require 'object_state/owner'
+require 'object_state/state'
+
+require 'object_state/version'

data/object_state.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'object_state/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'object_state'
+  spec.version       = ObjectState::VERSION
+  spec.authors       = ['Tomas Celizna']
+  spec.email         = ['tomas.celizna@gmail.com']
+
+  spec.summary       = "Encapsulates object's state, converts from/to params and to cache_key."
+  spec.homepage      = 'https://github.com/tomasc/object_state'
+  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_dependency 'activemodel', '>= 4', '<= 5'
+  spec.add_dependency 'activesupport', '>= 4', '<= 5'
+  spec.add_dependency 'virtus'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'mongoid', '>= 5.0', '< 6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: object_state
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Celizna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-minitest
+  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: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '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'
+description: 
+email:
+- tomas.celizna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/object_state.rb
+- lib/object_state/owner.rb
+- lib/object_state/state.rb
+- lib/object_state/version.rb
+- object_state.gemspec
+homepage: https://github.com/tomasc/object_state
+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.1
+signing_key: 
+specification_version: 4
+summary: Encapsulates object's state, converts from/to params and to cache_key.
+test_files: []