hokusai 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f863b83808f9657284136b67742c7603d6fbfef2
+  data.tar.gz: 678e6a74b4bfea5cd8cbdc3bf56ec16e4d5827f7
+SHA512:
+  metadata.gz: 148209dba74cb5298424a8ca3023b982c5fda80915b33e151859615ae83f4641d7bf441ca6bc3a5529b8018faf17fcff4416db90e0ca4a75f616e79f2a80509e
+  data.tar.gz: ce93b31386807f7ec79213ee79733bcbc0392ba4004162123afe6757f21e30620300b86f4cc0f677f08776aff3bca09005d23550deafefebe8c7af00c58aca96

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-gemset
+.DS_Store

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Josh Goodall
+
+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,147 @@
+# Hokusai
+
+Stamp out domain-specific clones of a model object, even after the original has departed, with these lightweight ActiveRecord concerns.
+
+## Quick demo
+
+If you want to write code like this, snapshotting an ActiveRecord object (and perhaps some associations) into a template:
+
+```ruby
+@template = Template.create!(origin: @project, name: "New template from project")
+```
+
+hoping to use it like this, at some later time (perhaps long after the origin has been deleted):
+
+```
+template = Template.find(params[:template_id])
+@new_project = template.stamp do |project|
+  project.name = "New project from template"
+end
+```
+
+then you have (maybe) come to the right place.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hokusai'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hokusai
+
+## Usage
+
+Include `Hokusai::Container` in an ActiveRecord model so that we can save templates in it. The columns `hokusai_class` and `hokusai_template` are required. You can add whatever data or metadata you wish, from a simple name to complex lifecycle or ownership attributes. In this example we just require a name:
+
+```ruby
+class Template < ApplicationRecord
+  include Hokusai::Container
+  validates :name, presence: true
+  before_validation :ensure_name
+
+  private
+  def ensure_name
+    self.name = "New #{hokusai_class.constantize.model_name.singular} template"
+  end
+end
+```
+
+Now create and run a suitable migration:
+
+```ruby
+class CreateTemplates < ActiveRecord::Migration
+  def change
+    create_table :templates do |t|
+      t.string :name, null: false
+      t.string :hokusai_class, null: false
+      t.text :hokusai_template, null: false
+      t.timestamps
+    end
+  end
+end
+```
+
+Then include `Hokusai::Templatable` in the models you want to make templates from. Declare a list of columns to persist, and which associations to include:
+
+```ruby
+class Device < ApplicationRecord
+  include Hokusai::Templatable
+
+  template :name, :model, :location, :year, include: [:interfaces]
+  has_many :interfaces
+end
+
+class Interface < ApplicationRecord
+  include Hokusai::Templatable
+  belongs_to :device
+
+  template :name, :address, :enabled
+end
+```
+
+You can then create a new template, and stamp out a copy:
+
+```ruby
+device = Device.create!(name: "router-1", model: "CX-6790", location: "SFO", year: 2017)
+device.interfaces.create!([
+  {name: "de0", address: "10.0.0.1", enabled: false},
+  {name: "lo0", address: "127.0.0.1", enabled: true}
+])
+
+template = Template.create!(origin: device, name: 'SFO router template')
+
+new_device = template.stamp do |device|
+  device.name = "router-2"
+end
+
+new_device.save!
+```
+
+This example ends with a deep, domain-specific clone of the origin object. You can delete the origin and the template is still useful.
+
+### What can Hokusai stamp out?
+
+Broadly speaking, this is intended for any ActiveRecord object that can be serialized to & from YAML.
+
+The `Hokusai::Templatable` concern is provided. This handles ordinary `has_many`, `has_one`, and `belongs_to` associations via the `include:` option, in which case it will call `as_template` on the associated records.  If you want a `belongs_to` reference id to carry across, serialize the _id column rather than including the association in the template.
+
+Recursive serialization is not currently detected and will cause a "stack level too deep" error. For those you may need to implement `as_template` by hand.
+
+Aggregates types may also need special treatment.  You can override `read_attribute_for_template` in the model for these.
+
+### Advanced configuration
+
+You're not constrained to using `Hokusai::Templatable`.  Any model that implements `#as_template` and `::from_template` will do, and the container doesn't impose constraints on their behaviour.  The only expectation is that `#as_template` returns a data structure ready for serialization as YAML, and that `::from_template` accepts the same structure as the first parameter.  Beyond that you can do as you please with the data.
+
+## Todo
+
+* Generator for the container migration.
+* Support for serializing self-referential data structures.
+* Clearer tests.
+* Comprehensive tests for a wide range of complicated associations.
+* Remove dependency on ActiveRecord.
+* Support configurable column names and template assignment method name.
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/inopinatus/hokusai.
+
+
+## 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 "hokusai"
+
+# 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(__FILE__)

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/hokusai.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hokusai/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hokusai"
+  spec.version       = Hokusai::VERSION
+  spec.authors       = ["Josh Goodall"]
+  spec.email         = ["inopinatus@inopinatus.org"]
+
+  spec.summary       = %q{Stamp out your models.}
+  spec.description   = %q{Stamp out copies of a model object, even after the original has departed, with these lightweight ActiveRecord concerns.}
+  spec.homepage      = "https://github.com/inopinatus/hokusai"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "activerecord", "> 5.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "activesupport", "> 5.0"
+end

data/lib/hokusai.rb

@@ -0,0 +1,122 @@
+require "hokusai/version"
+require "active_support"
+require "yaml"
+
+module Hokusai
+
+  ##
+  # Templatable models support taking a snapshot of their data, for later use stamping out clones.
+  #
+  # Include this module to obtain the +as_template+ and +from_template+ methods that support a simple container
+  # such as Hokusai::Container.
+  #
+  # Configure it with the +template+ declaration, which accepts a list of columns and an +includes+ option
+  # for nested assocations.
+  #
+  # === Example
+  #
+  #   class Device < ActiveRecord::Base
+  #     include Hokusai::Templatable
+  #
+  #     has_many :interfaces
+  #
+  #     template :name, :model, :location, :year, include: [:interfaces]
+  #   end
+
+  module Templatable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :🌊
+    end
+
+    module ClassMethods
+      # Define the template specification for the model.
+      def template(*template_columns, **options)
+        template_columns = Array(template_columns).map(&:to_s)
+        included_associations = Array(options[:include]).map(&:to_s)
+
+        self.🌊 = {
+          columns: template_columns,
+          associations: included_associations,
+        }
+      end
+
+      ##
+      # Build a new, unsaved instance of the model (and any included associations) from the template supplied.
+      # The block will be called with the new instance.
+      def from_template(template, &block)
+        if template.is_a?(Array)
+          template.map { |tpl| from_template(tpl, &block) }
+        else
+          new_attrs = template.slice(*🌊[:columns])
+          template.slice(*🌊[:associations]).each do |association, association_template|
+            new_attrs[association] = reflect_on_association(association).klass.from_template(association_template)
+          end
+          new(new_attrs, &block)
+        end
+      end
+    end
+
+    ##
+    # Serialize this object (and any included associations) according to the template specification.
+    def as_template
+      result_hash = {}
+
+      🌊[:columns].each_with_object(result_hash) do |column|
+        result_hash[column] = read_attribute_for_template(column)
+      end
+
+      🌊[:associations].each do |association|
+        records = send(association)
+        result_hash[association] = if records.respond_to?(:to_ary)
+          records.to_ary.map { |r| r.as_template }
+        else
+          records.as_template
+        end
+      end
+
+      result_hash
+    end
+
+    private
+    alias :read_attribute_for_template :send
+  end
+
+  ##
+  # This module supplies a simple container for snapshots of template-style data.
+  # These templates are used when stamping out new objects.
+  #
+  # A Hokusai container communicates with models via the +as_template+ method and +from_template+ class method.
+  # The data will be serialized as YAML; this container class is otherwise not concerned with its structure.
+  #
+  # Relies on the presence of two columns: +hokusai_class+ (string) and +hokusai_template+ (text).
+
+  module Container
+    extend ActiveSupport::Concern
+
+    included do
+      validates :hokusai_class, :hokusai_template, presence: true
+    end
+
+    # Set current template data, calling +as_template+ on the origin.
+    #
+    # Intended for use via <tt>@template = Template.new(origin: project, ...attrs...)</tt>
+    #
+    def origin=(object)
+      self.hokusai_class = object.class.to_s
+      self.hokusai_template = YAML.dump(object.as_template)
+    end
+
+    # Stamp out a new object from the template. Calls +from_template+ on the applicable class with
+    # the deserialized template data, passing on any supplied block.
+    #
+    # The semantics of +from_template+ are left to the receiving model.  If using the supplied
+    # concern <tt>Hokusai::Templatable</tt> then a new, unsaved model object will be instantiated,
+    # with nested models included as specified.
+    #
+    def stamp(&block)
+      hokusai_class.constantize.from_template(YAML.load(hokusai_template), &block)
+    end
+  end
+end

data/lib/hokusai/version.rb

@@ -0,0 +1,3 @@
+module Hokusai
+  VERSION = "0.1.3"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: hokusai
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Josh Goodall
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 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: activerecord
+  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: sqlite3
+  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: pry
+  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: 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'
+description: Stamp out copies of a model object, even after the original has departed,
+  with these lightweight ActiveRecord concerns.
+email:
+- inopinatus@inopinatus.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hokusai.gemspec
+- lib/hokusai.rb
+- lib/hokusai/version.rb
+homepage: https://github.com/inopinatus/hokusai
+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.11
+signing_key: 
+specification_version: 4
+summary: Stamp out your models.
+test_files: []