replication 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ada82be8564e12051c19fa8afab7242f5c5198f
+  data.tar.gz: 2fd0e08bc5bb4791297526988517c5ce22a018ad
+SHA512:
+  metadata.gz: 8e22185640c920637bc17646668b92733cc7564f58e0115652937e94fc04efff01d53abf0885c07133ffbdaad35e84d663abad1261328b49ee7903c61dd4cfdd
+  data.tar.gz: a3a54381d5322affc1bf64d031daea478514e7cff9263bb90c55b48295e53cb6dc0523b5091a56a87397877e14c1e1c5b0ca196e3530f8eef0ce1490f57466e9

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'orm_adapter', '~> 0.5'
+gem 'rails', '~> 4.0.5'
+
+group :test do
+  gem 'minitest-reporters'
+end
+
+platforms :ruby do
+  gem 'sqlite3'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rodrigo DeAlmeida
+
+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,120 @@
+# Replication
+
+Data replication as templates for Ruby ORMs.
+
+> ![DNA]
+>
+> DNA replication. The [double helix][] is unwound and each strand acts as a template for the next strand. [Bases][] are matched to synthesize the new partner strands.
+
+  [DNA]: https://upload.wikimedia.org/wikipedia/commons/thumb/7/70/DNA_replication_split.svg/200px-DNA_replication_split.svg.png
+  [double helix]: https://en.wikipedia.org/wiki/Double_helix "Double helix"
+  [Bases]: https://en.wikipedia.org/wiki/Nucleotides "Nucleotides"
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'replication'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install replication
+
+## Usage
+
+Extend ```Replication::Process``` in your models and declare it.
+```ruby
+class Model
+  extend Replication::Process
+  can_replicate
+end
+```
+
+Customize the 'pairs' method if you want.
+```ruby
+class Model
+  extend Replication::Process
+  can_replicate :attributes_alias # default method is 'attributes'
+end
+```
+
+Customize the class of the strands if you want.
+```ruby
+class Model
+  extend Replication::Process
+  can_replicate strand_class: WeirdStrandClass
+end
+```
+
+You can blacklist an array of attributes. They'll not be replicated in the new strand.
+```ruby
+can_replicate except: [:id, :name]
+```
+
+To 'unwound' a strand, do:
+```ruby
+model_instance = Model.new(attrs)
+model_instance.unwound(name: 'The Original Model') # returns a new strand
+```
+
+To 'unwound' and save a strand, do:
+```ruby
+model_instance = Model.new(attrs)
+model_instance.replicate(name: 'The Original Model') # returns a new persisted strand
+```
+
+To be able to 'unwound' only when the object is valid, include Proofreading.
+Right now it needs a ```valid?``` method to check.
+```ruby
+class Model
+  extend Replication::Process
+  can_replicate with: :proofreading
+end
+
+model_instance = Model.new(invalid_attrs)
+model_instance.unwound(name: 'The Original Model') # returns nil
+model_instance.replicate(name: 'The Original Model') # raises UnwoundError
+```
+
+To initialize a object that's descendant from the strand of another object, do:
+```ruby
+Model.new_from_strand([name or id])
+# or
+strand.replicate
+```
+
+### ActiveRecord
+
+For ActiveRecord strands, ```[:id, :created_at, :updated_at]``` will be blacklisted by default.
+
+It's highly recommended that you save your model instances before trying to replicate, since it
+needs the 'id' and 'type' references for the association.
+
+In some cases you don't want/won't need the strands to be associated, so, be free.
+
+### Rails
+
+Migrations are be provided by:
+```
+rake replication_engine:install:migrations
+```
+
+## TODO
+
+- Add ActiveRecord inverse association: 'strands'.
+- Refactoring, mainly about dependencies.
+- Thorough testing.
+- Scoping.
+- More ORMs/ODMs.
+
+## Contributing
+
+1. Fork it ( https://github.com/rodrigoddalmeida/replication/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,13 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task default: :test
+
+desc 'Run unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = false
+end

data/db/migrate/714417722_replication_migration.rb

@@ -0,0 +1,15 @@
+class ReplicationMigration < ActiveRecord::Migration
+  def self.up
+    create_table :strands do |t|
+      t.string :name
+      t.text :pairs
+      t.references :origin, polymorphic: true, index: true
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :strands
+  end
+end

data/lib/replication/active_record/strand.rb

@@ -0,0 +1,13 @@
+require "orm_adapter/adapters/active_record"
+
+module Replication
+  module ActiveRecord
+    class Strand < ::ActiveRecord::Base
+      extend Replication::StrandMethods
+      serialize :pairs
+      belongs_to :origin, polymorphic: true
+
+      validates :name, uniqueness: true, presence: true
+    end
+  end
+end

data/lib/replication/config.rb

@@ -0,0 +1,21 @@
+module Replication
+
+  class Config
+
+    attr_accessor :model_class, :pairs_method, :strand_class, :except
+
+    def initialize(model_class)
+      @model_class = model_class
+    end
+
+    def with(modules)
+      modules.each do |m|
+        model_class.send :extend, Replication::Modules.const_get(m.to_s.classify)
+      end
+    end
+
+    def set(options)
+      options and options.each {|name, value| self.send "#{name}=", value}
+    end
+  end
+end

data/lib/replication/engine.rb

@@ -0,0 +1,5 @@
+require 'rails/engine'
+module Replication
+  class Engine < Rails::Engine
+  end
+end

data/lib/replication/modules/proofreading.rb

@@ -0,0 +1,27 @@
+module Replication
+  module Modules
+    module Proofreading
+
+      def self.extended(model_class)
+        model_class.class_eval do
+          include Model
+        end
+      end
+
+      module Model
+
+        def unwound(**options)
+          super if valid?
+        end
+
+        def replicate(**options)
+          if valid?
+            super
+          else
+            raise Replication::UnwoundError, 'The origin must be valid!'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/replication/modules/semi_conservative.rb

@@ -0,0 +1,35 @@
+module Replication
+  module Modules
+    module SemiConservative
+
+      def self.extended(model_class)
+        model_class.class_eval do
+          include Model
+        end
+      end
+
+      module Model
+
+        def unwound(**options)
+          strand_class.new({
+            name: options[:name],
+            pairs: strand_attributes,
+            origin: self
+          })
+        end
+
+        def replicate(**options)
+          strand_class.to_adapter.create!({
+            name: options[:name],
+            pairs: strand_attributes,
+            origin: self
+          })
+        end
+
+        def strand_attributes
+          _strand_attributes.except(*replication_config.except)
+        end
+      end
+    end
+  end
+end

data/lib/replication/process.rb

@@ -0,0 +1,57 @@
+module Replication
+  module Process
+
+    def self.extended(model_class)
+      model_class.class_eval do
+        @@replication_config = Class.new(Config).new(self)
+        include Model
+      end
+    end
+
+    # Include or extend it. We work with both.
+    def self.included(model_class)
+      model_class.extend self
+    end
+
+    def can_replicate(pairs_method = :attributes, **options)
+      default_options = Replication.defaults
+      modules = [:semi_conservative] # required module
+      modules.concat(Array(options.delete(:with)))
+
+      @@replication_config.pairs_method = pairs_method
+      @@replication_config.set default_options.merge(options)
+      @@replication_config.with modules
+    end
+
+    def new_from_strand(id=nil, **options)
+      if id
+        strand = replication_config.strand_class.to_adapter.get!(id)
+      else
+        strand = replication_config.strand_class.to_adapter.find_first(options)
+      end
+
+      new(strand.pairs) if strand
+    end
+
+    def replication_config
+      @@replication_config
+    end
+
+    module Model
+
+      def strand_class
+        replication_config.strand_class
+      end
+
+      def replication_config
+        self.class.replication_config
+      end
+
+      private
+
+        def _strand_attributes
+          send(replication_config.pairs_method).deep_symbolize_keys
+        end
+    end
+  end
+end

data/lib/replication/strand_methods.rb

@@ -0,0 +1,16 @@
+module Replication
+  module StrandMethods
+
+    def self.extended(strand_class)
+      strand_class.class_eval do
+        include InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      def replicate
+        origin.new(pairs)
+      end
+    end
+  end
+end

data/lib/replication/version.rb

@@ -0,0 +1,3 @@
+module Replication
+  VERSION = "0.1.0"
+end

data/lib/replication.rb

@@ -0,0 +1,27 @@
+require "replication/version"
+
+module Replication
+
+  autoload :Process, 'replication/process'
+  autoload :Config, 'replication/config'
+  autoload :StrandMethods, 'replication/strand_methods'
+
+  module ActiveRecord
+    autoload :Strand, 'replication/active_record/strand'
+  end
+
+  module Modules
+    autoload :SemiConservative, 'replication/modules/semi_conservative'
+    autoload :Proofreading, 'replication/modules/proofreading'
+  end
+
+  def self.defaults
+    defaults = {}
+    defaults.merge({
+      strand_class: ::Replication::ActiveRecord::Strand,
+      except: [:id, :created_at, :updated_at]
+    }) if defined?(ActiveRecord)
+  end
+
+  class UnwoundError < StandardError; end;
+end

data/replication.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'replication/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "replication"
+  spec.version       = Replication::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Rodrigo DeAlmeida"]
+  spec.email         = ["rodrigoddalmeida@gmail.com"]
+  spec.summary       = %q{Data replication as templates for Ruby ORMs}
+  spec.description   = %q{Data replication as templates for Ruby ORMs}
+  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"
+end

data/test/orm/active_record.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.logger = Logger.new(nil)
+ActiveRecord::Base.include_root_in_json = true
+
+ActiveRecord::Migrator.migrate([File.expand_path("../../../db/migrate/", __FILE__), File.expand_path("../../rails_app/db/migrate/", __FILE__)])
+
+class ActiveSupport::TestCase
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures = false
+end

data/test/rails_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/rails_app/app/models/organism.rb

@@ -0,0 +1,3 @@
+class Organism < ::ActiveRecord::Base
+  validates :name, presence: true
+end

data/test/rails_app/config/application.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_model/railtie"
+# require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "action_view/railtie"
+# require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require :default, REPLICATION_ORM
+
+begin
+  require "#{REPLICATION_ORM}/railtie"
+rescue LoadError
+end
+
+require "replication"
+
+module RailsApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end

data/test/rails_app/config/boot.rb

@@ -0,0 +1,3 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/test/rails_app/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: ":memory:"
+
+production:
+  adapter: sqlite3
+  database: ":memory:"

data/test/rails_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/rails_app/config/environments/test.rb

@@ -0,0 +1,37 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/rails_app/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/rails_app/config/initializers/cookies_serializer.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/test/rails_app/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/test/rails_app/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/test/rails_app/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/test/rails_app/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store :cookie_store, key: '_rails_app_session'

data/test/rails_app/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end