sandboxy 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44501426bdcd615cc069e3327bbd6e37cc7f1496
-  data.tar.gz: dee2033f5deddb78dd4130b7d17f90e91f263cc0
+  metadata.gz: 3af3fd5a81896b5f9480bf645add749cbd57d009
+  data.tar.gz: 6ebb750a5ec79e5a91d71446b0f60987da39f72a
 SHA512:
-  metadata.gz: '071468637354c1ce9e6801f56bc8078ce8d7c7f09ac744e1a85469282c542c727302d68611a500ada44c57ef39fa0e47b077a816febf626c5441d45784147c68'
-  data.tar.gz: '080dc870bcf6be859c2b1e8fd238281997af4a0298ec35192f25de5b70cdbb21159009ac59ed0893f6276fe49d32f56fffca47d06d29d9a69cf0240199351e97'
+  metadata.gz: 6029e39f313ae946fb6fdfa413dfbc88e0437c080873d6c073a01490c02c71b6dd3ee7d9de3cff54b61e24b7285bb5aaf1bcbae8e1d488bd5a0deb724c6c71b7
+  data.tar.gz: 9f8bb2178a429068a9389b1df16dd49f1a614269a18479fffadd9503c9e75d0b67585d1c882512adf792f55dcbee670b40ef72f0b8fbd1370f4e20757b2bde1c

data/CHANGELOG.md

@@ -3,3 +3,12 @@
 ### master
 
 * nothing yet
+
+### 1.1.0 - 2017-08-27
+
+* features
+    * use rack middleware to refresh environment defaults on new requests
+
+### 1.0.0 - 2017-08-27
+
+* initial release

data/README.md

@@ -2,7 +2,7 @@
 
 <img src="https://travis-ci.org/slooob/sandboxy.svg?branch=master" /> [![Gem Version](https://badge.fury.io/rb/sandboxy.svg)](https://badge.fury.io/rb/sandboxy)
 
-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.
+Sandboxy allows you to use virtual data-oriented environments inside a Rails application while being able to switch in between at runtime. It achieves that by using a combination of Rack Middleware and ActiveRecord.
 
 ---
 
@@ -11,7 +11,9 @@ Sandboxy allows you to use two virtual data-oriented environments inside a Rails
 * [Installation](#installation)
 * [Usage](#usage)
     * [Setup](#setup)
+    * [Configuration](#configuration)
     * [Sandboxed methods](#sandboxed-methods)
+    * [Sandboxy methods](#sandboxy-methods)
     * [Switching environments](#switching-environments)
         * [Sandbox & APIs](#sandbox--apis)
 * [To Do](#to-do)
@@ -47,7 +49,11 @@ Now run the generator:
 
     $ rails g sandboxy
 
-You can specify that your application should use the sandbox by default by passing `--default true`. Learn more about switching environments [here](#switching-environments).
+You can specify your applications default environment by passing `--default live` or `--default sandbox`. Learn more about switching environments [here](#switching-environments).
+
+To set that your app should retain it's environment at runtime on new requests pass `--retain_environment true`.
+
+You can always update your [configuration](#configuration) later.
 
 To wrap things up, migrate the changes into your database:
 
@@ -55,13 +61,13 @@ To wrap things up, migrate the changes into your database:
 
 **Note:** Use `rake db:migrate` instead if you run Rails < 5.
 
-This will create an initializer as well as a migration file and the `Sandbox` model.
+This will create a configuration file under `config/sandboxy.yml` as well as a migration file and the `Sandbox` model.
 
 ## Usage
 
 ### Setup
 
-Add Sandboxy to the models where you want to separate live & sandbox reocrds:
+Add Sandboxy to the models where you want to separate live & sandbox records:
 
 ```ruby
 class Foo < ApplicationRecord
@@ -72,14 +78,20 @@ end
 In most use cases you would want to add sandboxy to a lot of ActiveRecord models if not all. To simplify that you could create a new class and let all your models inherit from it:
 
 ```ruby
-class Sandboxy < ApplicationRecord
+class SharedSandbox < ApplicationRecord
     sandboxy
 end
 
-class Foo < Sandboxy
+class Foo < SharedSandbox
 end
 ```
 
+### Configuration
+
+In `config/sandboxy.yml` you define your app's default environment. This can be either set to `live` or `sandbox`. It defaults to `live`.
+
+Now this default gets refreshed before every new request. To retain any environment you [switched in at runtime](#switching-environments), you need to set `retain_environment` to `true`. Defaults to `false`.
+
 ### Sandboxed methods
 
 By default you can only access records belonging to the current environment (`live` or `sandbox`):
@@ -116,11 +128,27 @@ foo.make_sandboxed
 foo.sandboxed? # => true
 ```
 
-### Switching environments
+### Sandboxy methods
+
+To access your default environment setting:
+
+```ruby
+Sandboxy.environment # => 'live' / 'sandbox'
+Sandboxy.sandbox? # => true / false
+Sandboxy.live? # => true / false
+```
+
+**Note:** `Sandboxy.environment` does *NOT* return the apps current environment. For that use the [`$sandbox` variable](#switching-environments) instead.
+
+You can also access whether your app retains your environment throughout request:
 
-In `config/initializers/sandboxy.rb` you define your app's default environment by setting the `$sandbox` variable.
+```ruby
+Sandboxy.retain_environment # => true / false
+```
+
+### Switching environments
 
-You can override that variable anywhere in your application. That makes Sandboxy super flexible.
+At runtime you can always switch environments by using the `$sandbox` variable anywhere in your application. Set it to `true` to enable the `sandbox` environment. Set it to `false` to enable the `live` environment. That makes Sandboxy super flexible.
 
 #### Sandbox & APIs
 

data/examples/rails_example/config/sandboxy.yml

@@ -0,0 +1,13 @@
+# ----------
+# Sandboxy
+# ----------
+
+# Set your environment default: Must be either `live` or `sandbox`.
+# This is the environment that your app boots with.
+# By default it gets refreshed with every new request to your server.
+# environment: 'live'
+
+# Specify whether to retain your current app environment on new requests.
+# If set to true, your app will only load your environment default when starting.
+# Every additional switch of your environment at runtime will then not be automatically resolved to your environment default on a new request.
+# retain_environment: false

data/lib/generators/sandboxy_generator.rb

@@ -7,7 +7,8 @@ class SandboxyGenerator < Rails::Generators::Base
 
     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'
+    class_option :default, desc: 'Set to default environment. Accepts either `live` or `sandbox`.', type: :boolean, default: false, aliases: '-d'
+    class_option :retain_environment, desc: "Whether your app should retain it's environment at runtime on new requests.", type: :boolean, default: false, aliases: '-re'
 
     def self.next_migration_number dirname
         if ActiveRecord::Base.timestamped_migrations
@@ -21,8 +22,8 @@ class SandboxyGenerator < Rails::Generators::Base
         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'
+    def create_configuration
+        template 'configuration.yml.erb', 'config/sandboxy.yml'
     end
 
     def create_model

data/lib/generators/templates/configuration.yml.erb

@@ -0,0 +1,13 @@
+# ----------
+# Sandboxy
+# ----------
+
+# Set your environment default: Must be either `live` or `sandbox`.
+# This is the environment that your app boots with.
+# By default it gets refreshed with every new request to your server.
+<% if options[:default] %>environment: <%= options[:default] %><% else %># environment: 'live'<% end %>
+
+# Specify whether to retain your current app environment on new requests.
+# If set to true, your app will only load your environment default when starting.
+# Every additional switch of your environment at runtime will then not be automatically resolved to your environment default on a new request.
+<% if options[:retain_environment] %>retain_environment: <%= options[:retain_environment] %><% else %># retain_environment: false<% end %>

data/lib/sandboxy/configuration.rb

@@ -0,0 +1,42 @@
+module Sandboxy
+
+    def self.environment
+        config = get_config
+        if config&.key :environment
+            config[:environment]
+        else
+            'live'
+        end
+    end
+
+    def self.sandbox?
+        Sandboxy.environment == 'sandbox' ? true : false
+    end
+
+    def self.live?
+        !Sandboxy.sandbox?
+    end
+
+    def self.retain_environment
+        config = get_config
+        if config&.key :retain_environment
+            config[:retain_environment]
+        else
+            false
+        end
+    end
+
+
+    private
+
+
+    def self.get_config
+        require 'yaml'
+
+        begin
+            YAML.load_file 'config/sandboxy.yml'
+        rescue Exception
+        end
+    end
+
+end

data/lib/sandboxy/middleware.rb

@@ -0,0 +1,15 @@
+module Sandboxy
+    class Middleware
+
+        def initialize app
+            @app = app
+        end
+
+        def call env
+            previous_sandbox = $sandbox
+            $sandbox = Sandboxy.environment == 'sandbox' ? true : false
+            puts 'Sandbox: Moved to ' + Sandboxy.environment + ' environment' if $sandbox != previous_sandbox
+        end
+
+    end
+end

data/lib/sandboxy/railtie.rb

@@ -1,5 +1,4 @@
 require 'rails'
-require 'sandboxy/sandboxed'
 
 
 module Sandboxy
@@ -11,5 +10,11 @@ module Sandboxy
             end
         end
 
+        initializer 'sandboxy.configure_rails_initialization' do |app|
+            puts 'Sandboxy: Using ' + Sandboxy.environment + ' environment'
+            $sandbox = Sandboxy.environment == 'sandbox' ? true : false
+            app.middleware.use(Sandboxy::Middleware) unless Sandboxy.retain_environment
+        end
+
     end
 end

data/lib/sandboxy/sandboxed.rb

@@ -43,7 +43,7 @@ module Sandboxy
             end
 
             def live?
-                !self.sandbox.present?
+                !self.sandboxed?
             end
 
         end

data/lib/sandboxy/version.rb

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

data/lib/sandboxy.rb

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

data/sandboxy.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
     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.description           = 'Sandboxy allows you to use virtual data-oriented environments inside a Rails application while being able to switch in between at runtime. It achieves that by using a combination of Rack Middleware and ActiveRecord.'
     gem.authors               = 'Slooob'
     gem.email                 = 'developer@slooob.com'
     gem.homepage              = 'https://developer.slooob.com/open-source'
@@ -17,13 +17,13 @@ Gem::Specification.new do |gem|
 
     gem.post_install_message  = IO.read('INSTALL.md')
 
-    gem.required_ruby_version = '>= 2.0'
+    gem.required_ruby_version = '>= 2.3'
 
     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 'shoulda_create', '~> 0.0'
     gem.add_development_dependency 'factory_girl', '~> 4.8'
     gem.add_development_dependency 'rails', '>= 4.0'
     gem.add_development_dependency 'tzinfo-data', '~> 1.2017'

data/test/dummy30/config/sandboxy.yml

@@ -0,0 +1 @@
+# Use defaults

data/test/sandbox_test.rb

@@ -2,7 +2,17 @@ require File.dirname(__FILE__) + '/test_helper'
 
 class SandboxTest < ActiveSupport::TestCase
 
-    context '#sandbox' do
+    context 'scopes' do
+        should 'be defined' do
+            assert Some.respond_to? :live_scoped
+            assert Some.respond_to? :sandboxed_scoped
+            assert Some.respond_to? :live
+            assert Some.respond_to? :sandboxed
+            assert Some.respond_to? :desandbox
+        end
+    end
+
+    context 'sandbox' do
         setup do
             @post = FactoryGirl.create :post
             @purchase = FactoryGirl.create :purchase
@@ -11,7 +21,7 @@ class SandboxTest < ActiveSupport::TestCase
             @receipt = FactoryGirl.create :receipt
         end
 
-        context 'desandbox' do
+        context '#desandbox' do
             should 'return all records' do
                 assert_equal Some.unscope(:joins, :where).all, Some.desandbox
             end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sandboxy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Slooob
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: shoulda_create
+  name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: shoulda_create
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +108,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2017'
-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.
+description: Sandboxy allows you to use virtual data-oriented environments inside
+  a Rails application while being able to switch in between at runtime. It achieves
+  that by using a combination of Rack Middleware and ActiveRecord.
 email: developer@slooob.com
 executables: []
 extensions: []
@@ -201,11 +202,11 @@ files:
 - examples/rails_example/config/initializers/filter_parameter_logging.rb
 - examples/rails_example/config/initializers/inflections.rb
 - examples/rails_example/config/initializers/mime_types.rb
-- examples/rails_example/config/initializers/sandboxy.rb
 - examples/rails_example/config/initializers/wrap_parameters.rb
 - examples/rails_example/config/locales/en.yml
 - examples/rails_example/config/puma.rb
 - examples/rails_example/config/routes.rb
+- examples/rails_example/config/sandboxy.yml
 - examples/rails_example/config/secrets.yml
 - examples/rails_example/db/migrate/20170826222427_sandboxy_migration.rb
 - examples/rails_example/db/migrate/20170826223227_create_foos.rb
@@ -245,10 +246,12 @@ files:
 - init.rb
 - lib/generators/sandboxy_generator.rb
 - lib/generators/templates/README.md
-- lib/generators/templates/initializer.rb.erb
+- lib/generators/templates/configuration.yml.erb
 - lib/generators/templates/migration.rb.erb
 - lib/generators/templates/model.rb
 - lib/sandboxy.rb
+- lib/sandboxy/configuration.rb
+- lib/sandboxy/middleware.rb
 - lib/sandboxy/railtie.rb
 - lib/sandboxy/sandboxed.rb
 - lib/sandboxy/version.rb
@@ -266,11 +269,11 @@ files:
 - test/dummy30/config/environment.rb
 - test/dummy30/config/environments/development.rb
 - test/dummy30/config/environments/test.rb
-- test/dummy30/config/initializers/sandboxy.rb
 - test/dummy30/config/initializers/secret_token.rb
 - test/dummy30/config/initializers/session_store.rb
 - test/dummy30/config/locales/en.yml
 - test/dummy30/config/routes.rb
+- test/dummy30/config/sandboxy.yml
 - test/factories/somes.rb
 - test/factories/users.rb
 - test/sandbox_test.rb
@@ -292,7 +295,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/examples/rails_example/config/initializers/sandboxy.rb

@@ -1,7 +0,0 @@
-# ----------
-# Sandboxy
-# ----------
-
-# Specify your default environment by setting `$sandbox`. Learn more: https://github.com/slooob/sandboxy
-$sandbox = false
-# $sandbox = true

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

@@ -1,7 +0,0 @@
-# ----------
-# 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/test/dummy30/config/initializers/sandboxy.rb

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