greyscale_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21e71af3947b0cc815cb95463fb059f8f6c0c2c7
+  data.tar.gz: f0300f7d0d2a42f81a330457aed57c8b132afd0d
+SHA512:
+  metadata.gz: eb71e778325000ea30ef6ba12a0c03d85db5c4f9598efc02052987fc55ed80c04371046ffed39f2c3ed6ca07fa8e9c2a618faa16186f714bba372028c7bb3214
+  data.tar.gz: a1abe9d7eddeb54d09d0e7d3788806bd451bc604d851cff03ce8820c27f8cf2ac107ecd7013fb002f548ddf8e2d91585693febcde3fda37c765d7a049c9ac251

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Greg Orlov
+
+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,69 @@
+# GreyscaleRails
+This is a collection of handy tools to make your life developing against the [Greyscale.io](http://www.greyscale.io) platform easy and delightful. 
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'greyscale_rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install greyscale_rails
+```
+
+## Usage
+
+There are a few things this gem provides
+
+### Config
+
+[GreyscaleRecord](http://github.com/greyscale-io/greyscale_record) is the default ORM for the Greyscale.io platform and there's some configuration that needs to happen, but it's somewhat verbose. To spare you the pain of reading all those docs, you can configure everything in a single yaml file: `greyscale.yml`
+
+Here's what it looks like
+
+```yml
+development:
+  driver: yaml
+  data_root: db/fixtures
+  live_reload: true
+
+test:
+  driver: yaml
+  data_root: test/db/fixtures
+
+production:
+  driver: greyscale
+  data_root: http://api.greyscale.io
+  revision_root: http://revisions.greyscale.io
+  app_id: <APP_ID>
+  app_key: <APP_KEY>
+```
+
+Here's what all the fields are:
+
+* `driver`: tells the application to load the proper data fetcher. The options are
+  * `yaml`: will load yaml files from your local file system folder, specified by `data_root`
+  * `greyscale`: will load data from a remote server that complies to the Greyscale.io API standard
+* `data_root`: the root path of the source from which you want to load your data
+* `revision_root`: the root path of the source from which you load data [previews](#patchable)
+* `app_id`: Your app's Greyscale.io API id
+* `app_key`: Your app's Greyscale.io API key
+
+### Patchable 
+
+This is a module that's loaded into Application Controller that detects a revision key in `params[:revision]`, and automatically applies the patch for the duration of the call.
+
+__NOTE__: it applies it to `GreycaleRecord::Base`'s data store, so if you have more than one store that you are using, this may not work as well as you hope. 
+
+## 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,36 @@
+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    = 'GreyscaleRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+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/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/greyscale_rails/engine.rb

@@ -0,0 +1,4 @@
+module GreyscaleRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/greyscale_rails/patchable.rb

@@ -0,0 +1,39 @@
+module GreyscaleRails
+  module Patchable
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :apply_patch
+      after_action  :remove_patch
+
+      def apply_patch
+        revision = params[:revision]
+
+        if revision.present?
+
+          definition = patch_driver.load! revision
+          
+          patch = Hana::Patch.new( definition[:patch] )
+
+          GreyscaleRecord::Base.data_store.apply_patch patch
+
+          Rails.logger.debug "Aplying patch: #{patch.inspect}"
+        end
+      rescue => e
+        Rails.logger.error "Failed to apply patch #{revision}: #{e}"
+
+        GreyscaleRecord::Base.data_store.remove_patch
+      end
+
+      def remove_patch
+        GreyscaleRecord::Base.data_store.remove_patch
+      end
+
+      private
+
+      def patch_driver
+        GreyscaleRails.patch_driver
+      end
+    end
+  end
+end

data/lib/greyscale_rails/railtie.rb

@@ -0,0 +1,66 @@
+module GreyscaleRails
+  class Railtie < Rails::Railtie
+    config.greyscale = ActiveSupport::OrderedOptions.new
+
+    config.greyscale.config_path = "config/greyscale.yml"
+
+    initializer "greyscale.configure" do | app |
+
+      load_config!( app )
+
+      GreyscaleRecord.logger = Rails.logger
+
+      data_store = GreyscaleRecord::DataStore::Engine.new config.greyscale.data_driver
+
+      GreyscaleRecord::Base.data_store = data_store
+
+      if config.greyscale.patch_driver.present?
+        GreyscaleRails.patch_driver = config.greyscale.patch_driver
+      end
+
+    end
+
+    private
+
+    def load_config!( app )
+
+      path = config_path( app )
+
+      yaml = YAML.load_file( path ).with_indifferent_access[Rails.env.to_s]
+
+      config.greyscale.data_driver = data_driver yaml
+
+      if yaml[:revision_root].present?
+        config.greyscale.patch_driver = data_driver yaml.merge( data_root: yaml[ :revision_root ] )
+      end
+
+    rescue => e
+      raise "Failed to process #{config.greyscale.config_path}. Make sure the file exists and is not malformed. Error: \"#{e}\""
+    end
+
+    def config_path( app )
+      File.expand_path(config.greyscale.config_path, app.root)
+    end
+
+    def data_driver( yaml )
+      type = yaml[ :driver ].to_sym
+      root = yaml[ :data_root ]
+
+      driver_class = DRIVER_TYPES[type]
+      raise "Grreyscale Rails error: #{type} is not a valid driver. Please choose from: #{DRIVER_TYPES.keys.join(", ")}" unless driver_class
+
+      driver = driver_class.new root
+
+      if driver.respond_to?( :api_key ) && driver.respond_to?( :api_id )
+        driver.api_id = yaml[:api_id]
+        driver.api_key = yaml[:api_key]
+      end
+
+      driver
+    end
+
+    DRIVER_TYPES = { yaml: GreyscaleRecord::Drivers::Yaml,
+                     # greyscale: GreyscaleRails::Drivers::Greyscale
+                   }
+  end
+end

data/lib/greyscale_rails/version.rb

@@ -0,0 +1,3 @@
+module GreyscaleRails
+  VERSION = '0.0.1'
+end

data/lib/greyscale_rails.rb

@@ -0,0 +1,12 @@
+require "greyscale_rails/engine"
+require 'greyscale_record'
+require 'hana'
+require 'greyscale_rails/railtie'
+
+module GreyscaleRails
+  autoload :Patchable,  "greyscale_rails/patchable"
+
+  class << self
+    attr_accessor :patch_driver
+  end
+end

data/lib/tasks/greyscale_rails_tasks.rake

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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: greyscale_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Greg Orlov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: greyscale_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: hana
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: 'Rails integration with GReyscale platform tools: setup, environment
+  management, plugins'
+email:
+- gaorlov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/greyscale_rails_manifest.js
+- config/routes.rb
+- lib/greyscale_rails.rb
+- lib/greyscale_rails/engine.rb
+- lib/greyscale_rails/patchable.rb
+- lib/greyscale_rails/railtie.rb
+- lib/greyscale_rails/version.rb
+- lib/tasks/greyscale_rails_tasks.rake
+homepage: http://github.com/greyscale-io/greyscale_rails
+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.5.2
+signing_key: 
+specification_version: 4
+summary: A collection of tools to make GReywscale development easier
+test_files: []