sandboxy 1.0.0

data/examples/rails_example/test/controllers/bars_controller_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+class BarsControllerTest < ActionDispatch::IntegrationTest
+  setup do
+    @bar = bars(:one)
+  end
+
+  test "should get index" do
+    get bars_url
+    assert_response :success
+  end
+
+  test "should get new" do
+    get new_bar_url
+    assert_response :success
+  end
+
+  test "should create bar" do
+    assert_difference('Bar.count') do
+      post bars_url, params: { bar: {  } }
+    end
+
+    assert_redirected_to bar_url(Bar.last)
+  end
+
+  test "should show bar" do
+    get bar_url(@bar)
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get edit_bar_url(@bar)
+    assert_response :success
+  end
+
+  test "should update bar" do
+    patch bar_url(@bar), params: { bar: {  } }
+    assert_redirected_to bar_url(@bar)
+  end
+
+  test "should destroy bar" do
+    assert_difference('Bar.count', -1) do
+      delete bar_url(@bar)
+    end
+
+    assert_redirected_to bars_url
+  end
+end

data/examples/rails_example/test/controllers/foos_controller_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+class FoosControllerTest < ActionDispatch::IntegrationTest
+  setup do
+    @foo = foos(:one)
+  end
+
+  test "should get index" do
+    get foos_url
+    assert_response :success
+  end
+
+  test "should get new" do
+    get new_foo_url
+    assert_response :success
+  end
+
+  test "should create foo" do
+    assert_difference('Foo.count') do
+      post foos_url, params: { foo: {  } }
+    end
+
+    assert_redirected_to foo_url(Foo.last)
+  end
+
+  test "should show foo" do
+    get foo_url(@foo)
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get edit_foo_url(@foo)
+    assert_response :success
+  end
+
+  test "should update foo" do
+    patch foo_url(@foo), params: { foo: {  } }
+    assert_redirected_to foo_url(@foo)
+  end
+
+  test "should destroy foo" do
+    assert_difference('Foo.count', -1) do
+      delete foo_url(@foo)
+    end
+
+    assert_redirected_to foos_url
+  end
+end

data/examples/rails_example/test/fixtures/bars.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+# This model initially had no columns defined. If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+# column: value

data/examples/rails_example/test/fixtures/foos.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+# This model initially had no columns defined. If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+# column: value

data/examples/rails_example/test/models/bar_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BarTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/examples/rails_example/test/models/foo_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class FooTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/examples/rails_example/test/system/bars_test.rb

@@ -0,0 +1,9 @@
+require "application_system_test_case"
+
+class BarsTest < ApplicationSystemTestCase
+  # test "visiting the index" do
+  #   visit bars_url
+  #
+  #   assert_selector "h1", text: "Bar"
+  # end
+end

data/examples/rails_example/test/system/foos_test.rb

@@ -0,0 +1,9 @@
+require "application_system_test_case"
+
+class FoosTest < ApplicationSystemTestCase
+  # test "visiting the index" do
+  #   visit foos_url
+  #
+  #   assert_selector "h1", text: "Foo"
+  # end
+end

data/examples/rails_example/test/test_helper.rb

@@ -0,0 +1,9 @@
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/init.rb

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

data/lib/generators/sandboxy_generator.rb

@@ -0,0 +1,44 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class SandboxyGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.join File.dirname(__FILE__), 'templates'
+    desc 'Install sandboxy'
+    class_option :default, desc: 'Set the default $sandbox indicator', type: :boolean, default: false, aliases: '-d'
+
+    def self.next_migration_number dirname
+        if ActiveRecord::Base.timestamped_migrations
+            Time.now.utc.strftime '%Y%m%d%H%M%S'
+        else
+            "%.3d" % (current_migration_number(dirname) + 1)
+        end
+    end
+
+    def create_migration_file
+        migration_template 'migration.rb.erb', 'db/migrate/sandboxy_migration.rb', migration_version: migration_version
+    end
+
+    def create_initializer
+        template 'initializer.rb.erb', 'config/initializers/sandboxy.rb'
+    end
+
+    def create_model
+        template 'model.rb', 'app/models/sandbox.rb'
+    end
+
+    def show_readme
+        readme 'README.md'
+    end
+
+    private
+
+    def migration_version
+        if Rails.version >= '5.0.0'
+            "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+    end
+
+end

data/lib/generators/templates/README.md

@@ -0,0 +1 @@
+Now run `rails db:migrate` to add sandboxy to your database.

data/lib/generators/templates/initializer.rb.erb

@@ -0,0 +1,7 @@
+# ----------
+# Sandboxy
+# ----------
+
+# Specify your default environment by setting `$sandbox`. Learn more: https://github.com/slooob/sandboxy
+<% if options[:default] == true %># <% end %>$sandbox = false
+<% if options[:default] == false %># <% end %>$sandbox = true

data/lib/generators/templates/migration.rb.erb

@@ -0,0 +1,14 @@
+class SandboxyMigration < ActiveRecord::Migration<%= migration_version %>
+    def self.up
+        create_table :sandboxy, force: true do |t|
+            t.references :sandboxed, polymorphic: true, null: false
+            t.timestamps
+        end
+
+        add_index :sandboxy, ['sandboxed_id', 'sandboxed_type'], name: 'sandboxy_sandboxed'
+    end
+
+    def self.down
+        drop_table :sandboxy
+    end
+end

data/lib/generators/templates/model.rb

@@ -0,0 +1,7 @@
+class Sandbox < ActiveRecord::Base
+
+    self.table_name = 'sandboxy'
+
+    belongs_to :sandboxed, polymorphic: true
+
+end

data/lib/sandboxy/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails'
+require 'sandboxy/sandboxed'
+
+
+module Sandboxy
+    class Railtie < Rails::Railtie
+
+        initializer 'sandboxy.active_record' do
+            ActiveSupport.on_load :active_record do
+                include Sandboxy::Sandboxed
+            end
+        end
+
+    end
+end

data/lib/sandboxy/sandboxed.rb

@@ -0,0 +1,52 @@
+module Sandboxy
+    module Sandboxed
+
+        def self.included base
+            base.extend ClassMethods
+        end
+
+        module ClassMethods
+
+            def sandboxy
+                has_one :sandbox, as: :sandboxed, dependent: :destroy
+                include Sandboxy::Sandboxed::InstanceMethods
+
+                scope :live_scoped, -> { left_outer_joins(:sandbox).where(sandbox: { id: nil }) }
+                scope :sandboxed_scoped, -> { left_outer_joins(:sandbox).where.not(sandbox: { id: nil }) }
+                default_scope {
+                    case $sandbox
+                    when true then sandboxed_scoped
+                    when false then live_scoped
+                    end
+                }
+                scope :live, -> { unscope(:joins, :where).live_scoped }
+                scope :sandboxed, -> { unscope(:joins, :where).sandboxed_scoped }
+                scope :desandbox, -> { unscope(:joins, :where).all }
+
+                # before_save :make_sandboxed # -> should be handled automatically through default_scope
+            end
+
+        end
+
+        module InstanceMethods
+
+            def make_sandboxed
+                self.build_sandbox unless self.sandbox.present?
+            end
+
+            def make_live
+                self.sandbox.destroy if self.sandbox.present?
+            end
+
+            def sandboxed?
+                self.sandbox.present?
+            end
+
+            def live?
+                !self.sandbox.present?
+            end
+
+        end
+
+    end
+end

data/lib/sandboxy/version.rb

@@ -0,0 +1,5 @@
+module Sandboxy
+
+    VERSION = '1.0.0'
+
+end

data/lib/sandboxy.rb

@@ -0,0 +1,10 @@
+require 'sandboxy/version'
+
+
+module ActsAsFavoritor
+
+    autoload :Sandboxed, 'sandboxy/sandboxed'
+
+    require 'sandboxy/railtie' # if defined?(Rails)
+
+end

data/sandboxy.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path(File.join('..', 'lib', 'sandboxy', 'version'), __FILE__)
+
+Gem::Specification.new do |gem|
+    gem.name                  = 'sandboxy'
+    gem.version               = Sandboxy::VERSION
+    gem.platform              = Gem::Platform::RUBY
+    gem.summary               = 'Virtual data-oriented environments for Rails'
+    gem.description           = 'Sandboxy allows you to use two virtual data-oriented environments inside a Rails application with ActiveRecord while being able to switch in between at runtime.'
+    gem.authors               = 'Slooob'
+    gem.email                 = 'developer@slooob.com'
+    gem.homepage              = 'https://developer.slooob.com/open-source'
+    gem.license               = 'MIT'
+
+    gem.files                 = `git ls-files`.split("\n")
+    gem.require_paths         = ['lib']
+
+    gem.post_install_message  = IO.read('INSTALL.md')
+
+    gem.required_ruby_version = '>= 2.0'
+
+    gem.add_dependency 'activerecord', '>= 4.0'
+
+    gem.add_development_dependency 'sqlite3', '~> 1.3'
+    gem.add_development_dependency 'shoulda_create', '~> 0.0'
+    gem.add_development_dependency 'shoulda', '~> 3.5'
+    gem.add_development_dependency 'factory_girl', '~> 4.8'
+    gem.add_development_dependency 'rails', '>= 4.0'
+    gem.add_development_dependency 'tzinfo-data', '~> 1.2017'
+end

data/test/dummy30/Gemfile

@@ -0,0 +1 @@
+gem 'rails', '~> 5.1.3'

data/test/dummy30/Rakefile

@@ -0,0 +1,4 @@
+require File.expand_path '../config/application', __FILE__
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy30/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+end

data/test/dummy30/app/models/shared_sandbox.rb

@@ -0,0 +1,4 @@
+class SharedSandbox < ApplicationRecord
+    self.abstract_class = true
+    sandboxy
+end

data/test/dummy30/app/models/some.rb

@@ -0,0 +1,3 @@
+class Some < SharedSandbox
+    validates_presence_of :name
+end

data/test/dummy30/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < SharedSandbox
+    validates_presence_of :name
+end

data/test/dummy30/config/application.rb

@@ -0,0 +1,14 @@
+require File.expand_path '../boot', __FILE__
+
+require 'active_model/railtie'
+require 'active_record/railtie'
+
+Bundler.require
+require 'sandboxy'
+
+module Dummy
+    class Application < Rails::Application
+        config.encoding = 'utf-8'
+        config.filter_parameters += [:password]
+    end
+end

data/test/dummy30/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path '../../../../Gemfile', __FILE__
+
+if File.exist?(gemfile)
+    ENV['BUNDLE_GEMFILE'] = gemfile
+    require 'bundler'
+    Bundler.setup
+end
+
+$:.unshift File.expand_path '../../../../lib', __FILE__

data/test/dummy30/config/database.yml

@@ -0,0 +1,6 @@
+test:
+    adapter: sqlite3
+    database: ':memory:'
+development:
+    adapter: sqlite3
+    database: ':memory:'

data/test/dummy30/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path '../application', __FILE__
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy30/config/environments/development.rb

@@ -0,0 +1,7 @@
+Dummy::Application.configure do
+    config.cache_classes = false
+    config.whiny_nils = true
+    config.consider_all_requests_local = true
+    config.active_support.deprecation = :log
+    config.eager_load = false
+end

data/test/dummy30/config/environments/test.rb

@@ -0,0 +1,6 @@
+Dummy::Application.configure do
+    config.cache_classes = true
+    config.consider_all_requests_local = true
+    config.active_support.deprecation = :stderr
+    config.eager_load = false
+end

data/test/dummy30/config/initializers/sandboxy.rb

@@ -0,0 +1 @@
+$sandbox = false

data/test/dummy30/config/initializers/secret_token.rb

@@ -0,0 +1 @@
+Dummy::Application.config.secret_token = '7b0ce915dc4c2ee60581c2769798abb5e4078292ad23670fc8d728953fc13aec19863558873234816b58a54f6a35be58b2b0a26749a7dfddcd2f02ee82d7e94f'

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

@@ -0,0 +1 @@
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'

data/test/dummy30/config/locales/en.yml

@@ -0,0 +1,2 @@
+en:
+  hello: 'Hello world'

data/test/dummy30/config/routes.rb

@@ -0,0 +1,2 @@
+Dummy::Application.routes.draw do
+end

data/test/dummy30/config.ru

@@ -0,0 +1,2 @@
+require ::File.expand_path '../config/environment', __FILE__
+run Dummy::Application

data/test/factories/somes.rb

@@ -0,0 +1,17 @@
+FactoryGirl.define do
+    factory :post, class: Some do |b|
+        b.name 'Post'
+    end
+
+    factory :purchase, class: Some do |b|
+        b.name 'Purchase'
+    end
+
+    factory :book, class: Some do |b|
+        b.name 'Book'
+    end
+
+    factory :receipt, class: Some do |b|
+        b.name 'Receipt'
+    end
+end

data/test/factories/users.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+    factory :sam, class: User do |u|
+        u.name 'Sam'
+    end
+end

data/test/sandbox_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SandboxTest < ActiveSupport::TestCase
+
+    context '#sandbox' do
+        setup do
+            @post = FactoryGirl.create :post
+            @purchase = FactoryGirl.create :purchase
+            $sandbox = true
+            @book = FactoryGirl.create :book
+            @receipt = FactoryGirl.create :receipt
+        end
+
+        context 'desandbox' do
+            should 'return all records' do
+                assert_equal Some.unscope(:joins, :where).all, Some.desandbox
+            end
+        end
+
+        context '#live' do
+            setup do
+                $sandbox = false
+            end
+
+            should 'return all live records' do
+                assert_equal Some.all, Some.live
+            end
+        end
+
+        context '#sandboxed' do
+            setup do
+                $sandbox = true
+            end
+
+            should 'return all sandboxed records' do
+                assert_equal Some.all, Some.sandboxed
+            end
+        end
+    end
+
+end

data/test/sandboxed_test.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SandboxedTest < ActiveSupport::TestCase
+
+    context 'instance methods' do
+        setup do
+            @post = FactoryGirl.create :post
+        end
+
+        should 'be defined' do
+            assert @post.respond_to? :make_sandboxed
+            assert @post.respond_to? :make_live
+            assert @post.respond_to? :sandboxed?
+            assert @post.respond_to? :live?
+        end
+    end
+
+    context 'sandboxed' do
+        setup do
+            @post = FactoryGirl.create :post
+            @purchase = FactoryGirl.create :purchase
+            $sandbox = true
+            @book = FactoryGirl.create :book
+            @receipt = FactoryGirl.create :receipt
+        end
+
+        context '#sandboxed?' do
+            should 'be true for @book & @receipt' do
+                @book.make_sandboxed ##### SHOULD NOT BE NECESSARY #####
+                @receipt.make_sandboxed ##### SHOULD NOT BE NECESSARY #####
+                assert_equal true, @book.sandboxed?
+                assert_equal true, @receipt.sandboxed?
+            end
+        end
+
+        context '#live?' do
+            should 'be true for @post & @purchase' do
+                assert_equal true, @post.live?
+                assert_equal true, @purchase.live?
+            end
+        end
+
+        context '#make_sandboxed' do
+            should 'move record to sandboxed environment' do
+                @purchase.make_sandboxed
+                assert_equal true, @purchase.sandboxed?
+            end
+        end
+
+        context '#make_live' do
+            should 'move record to live environment' do
+                @receipt.make_live
+                assert_equal true, @receipt.live?
+            end
+        end
+    end
+
+end

data/test/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define version: 0 do
+
+    create_table :sandboxy, force: true do |t|
+        t.integer :sandboxed_id, null: false
+        t.string :sandboxed_type, null: false
+        t.datetime :created_at
+        t.datetime :updated_at
+    end
+
+    create_table :users, force: true do |t|
+        t.column :name, :string
+    end
+
+    create_table :somes, force: true do |t|
+        t.column :name, :string
+    end
+
+end