active_preview 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4271152b50d079c85187b6f598c0be48fac5aab3e3a4d7cfe3a1e76b380f2e6f
+  data.tar.gz: 70513536578312ae01f25b4ad61c9f36ef1697d3cc6fa415739c970e8fc9df92
+SHA512:
+  metadata.gz: 62b5504560d84ce3c20dca30cd139aec9b26a874ed085a2bef93f17da13acebea60bd2cc02f1bdf0d8b5f2601246cb607e7b99d0032e7afc49ab1c4ccf2296b3
+  data.tar.gz: 18a667682ecb1eabad0b54dd650c222385dab411acabe658600fd80463552e09d216f4f4db42762838f857609bf9929c0ad0c7cc9acad0274d8225f175a09475

data/README.md

@@ -0,0 +1,43 @@
+# ActivePreview
+active_preview is a Ruby on Rails plugin that makes it easy to create previews of updates to records. The previews don't interact with the database but otherwise behave like ActiveRecord objects.
+
+## Usage
+To preview a model, first run the generator:
+```bash
+$ rails generate active_preview:preview --model MyModel
+```
+This will create `my_model_preview.rb` in `app/previews`. If you have methods that touch the database in your model that need to be used with previewed data, override them there. 
+
+Next, add the `#preview` method to your model:
+```ruby
+class MyModel < ActiveRecord::Base
+  include ActivePreview::Previewing
+end
+```
+
+Now you can pass an attribute hash or `ActionController::Parameters` object to `my_model.preview` to get a preview object with updated attributes that behaves exactly like your model.
+
+For models with associations, run the generator for each associated model and add `include ActivePreview::Previewing` to each model class.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_preview'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install active_preview
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActivePreview'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/active_preview/association_helper.rb

@@ -0,0 +1,17 @@
+module AssociationHelper
+  def association_from_key(key)
+    key.to_s.split("_").tap { |arr| arr.delete("attributes") }.join("_")
+  end
+
+  def associations(klass)
+    klass.reflect_on_all_associations.map { |a| a.name.to_s }
+  end
+
+  def association_class(klass:, key:)
+    klass.reflect_on_association(association_from_key(key)).klass
+  end
+
+  def singular?(name)
+    name.singularize == name
+  end
+end

data/lib/active_preview/override_persistence.rb

@@ -0,0 +1,28 @@
+module OverridePersistence
+  # TODO: maybe raise a helpful error?
+  def becomes; end
+  def becomes! ; end
+  def decrement; end
+  def decrement!; end
+  def delete; end
+  def destroy; end
+  def destroy!; end
+  def destroyed? ; end
+  def increment; end
+  def increment! ; end
+  def new_record?; end
+  def persisted?; end
+  def reload; end
+  def save; end
+  def save! ; end
+  def toggle; end
+  def toggle!; end
+  def touch ; end
+  def update; end
+  def update!; end
+  def update_attribute; end
+  def update_attributes; end
+  def update_attributes!; end
+  def update_column; end
+  def update_columns ; end
+end

data/lib/active_preview/preview.rb

@@ -0,0 +1,34 @@
+require "active_preview/override_persistence"
+
+module ActivePreview
+  class Preview < SimpleDelegator
+    include OverridePersistence
+    include AssociationHelper
+
+    def initialize(record)
+      redefine_associations(record)
+      super(record)
+    end
+
+    def original
+      __getobj__
+    end
+
+    # ~ used in place of association names
+    SINGULAR = %w(create_~ create_~! reload_~)
+    COLLECTION = %w(~_id ~_id= ~<<)
+
+    private
+
+    def redefine_associations(record)
+      associations(record.class).each do |a|
+        next if respond_to? a # avoid redefining methods
+        methods = singular?(a) ? SINGULAR : COLLECTION
+        methods.each do |method|
+          self.class.send(:define_method, method.gsub("~", a)) {}
+        end
+        self.class.send(:attr_accessor, a)
+      end
+    end
+  end
+end

data/lib/active_preview/previewing.rb

@@ -0,0 +1,66 @@
+module ActivePreview
+  module Previewing
+    extend ActiveSupport::Concern
+    include AssociationHelper
+
+    included do
+      def self.collection_preview(saved, params)
+        child_args(saved, params).map do |obj, attrs|
+          if obj
+            obj.preview(attrs)
+          else
+            self.new(attrs).preview
+          end
+        end
+      end
+
+      private
+
+      def self.child_args(saved, child_attrs)
+        if saved.size > child_attrs.size
+          saved.zip(child_attrs)
+        else
+          child_attrs.zip(saved).map(&:reverse!)
+        end
+      end
+    end
+
+    # Returns an unsaved object with updated attributes, along with any
+    # child objects and their updated attributes.
+    # Note that the associations are not assigned, so parent.children will be
+    # empty
+    def preview(params)
+      merged_object(params).tap do |p|
+        child_keys(params).each do |params_key|
+          association = association_from_key(params_key)
+          next unless associations(self.class).include?(association)
+          p.send("#{association}=", generate_children(params, params_key))
+        end
+      end
+    end
+
+    private
+
+    def merged_object(new_attrs)
+      preview_class.new(self.class.new(self.attributes.merge(new_attrs)))
+    end
+
+    def preview_class
+      "#{self.class}Preview".constantize
+    end
+
+    def child_keys(hash)
+      hash.map do |k, v|
+        k if v.is_a?(ActionController::Parameters) || v.is_a?(Hash)
+      end.compact
+    end
+
+    def generate_children(params, *params_keys)
+      child_params = params.dig(*params_keys).to_h.values
+        .sort! { |a, b| a["id"] <=> b["id"] }
+      klass = association_class(klass: self.class, key: params_keys.last)
+      saved = klass.where(id: child_params.map { |p| p["id"] }).order(:id)
+      klass.collection_preview(saved, child_params)
+    end
+  end
+end

data/lib/active_preview/version.rb

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

data/lib/active_preview.rb

@@ -0,0 +1,7 @@
+require "active_preview/association_helper"
+require "active_preview/preview"
+require "active_preview/previewing"
+
+module ActivePreview
+  # Your code goes here...
+end

data/lib/rails/generators/active_preview/preview_generator.rb

@@ -0,0 +1,16 @@
+module ActivePreview
+  module Generators
+    class PreviewGenerator < Rails::Generators::Base
+      desc "Creates a Preview class for the given model and its associated "\
+           "models"
+      class_option :model, type: :string
+      def create_preview
+        model = options[:model].downcase
+        empty_directory "app/previews"
+        create_file "app/previews/#{model}_preview.rb",
+                    "class #{model.capitalize}Preview < ActivePreview::Preview"\
+                    "\nend\n"
+      end
+    end
+  end
+end

data/lib/tasks/active_preview_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :active_preview do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: active_preview
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Syd Young
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !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-rails
+  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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-github
+  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'
+description: 
+email:
+- sky@eff.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/active_preview.rb
+- lib/active_preview/association_helper.rb
+- lib/active_preview/override_persistence.rb
+- lib/active_preview/preview.rb
+- lib/active_preview/previewing.rb
+- lib/active_preview/version.rb
+- lib/rails/generators/active_preview/preview_generator.rb
+- lib/tasks/active_preview_tasks.rake
+homepage: https://github.com/efforg/active_preview
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Create previews of ActiveRecord objects that don't                                                                                                                modify
+  the database
+test_files: []