goa 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd82437d80dd28fe367dd0c90e38004cb7378af9
+  data.tar.gz: 16854d1fa1cf54237696765ec3ea5f5ab03e56b1
+SHA512:
+  metadata.gz: d8d22b9f839d6c2d80463d3b710a9d50d06516060f2ede0510ff06e0e19f66d0328708854ffa3d73fc155a766c1ef0a4a0402547cf1e6057bf26d91b0a731561
+  data.tar.gz: 1a0032b62a4960ed96e9490d57f2ce26f5ecbff62b632bbe1e3ff3ca7065b487149d9e4b2a6abf27e68e6bbf9b7b1991b8a3933b3091463ab52a40a15d5546e8

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in goa.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Rafter, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/LICENSE.txt

@@ -0,0 +1 @@
+Copyright (c) 2013 Rafter.com

data/README.md

@@ -0,0 +1,80 @@
+# Goa
+
+This Gem aids in creating a Rails Engine that has access to models in a separate database than the
+hosting application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'goa'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install goa
+
+## Usage
+
+* Create a Rakefile in your Rails Engine's lib/tasks folder:
+
+    my_rails_engine.rake
+
+```ruby
+require 'goa'
+
+GOA::RakeTasks.new.add_rake_tasks
+```
+
+You can now execute this:
+```ruby
+bundle exec app:db:drop app:db:create app:db:schema:load app:db:migrate app:db:test:prepare
+```
+
+* Add a fake Rails app to your test/spec directory:
+
+TODO (Generator?)
+
+* Add Models to your gem as you would a rails application, except make sure they all have a common base class:
+
+    app/models/my_goa_gem/base.rb
+
+```ruby
+require 'goa'
+
+class MyGoaGem::Base < ActiveRecord::Base
+  self.abstract_class = true
+
+  # Establish connection in a base class so all models will share the connection
+  establish_connection GOA::Config.database_config(MyGoaGem::Engine.root)
+end
+```
+
+* Add to your test_helper.rb/spec_helper.rb to clean your database (also requires 'database_cleaner'):
+
+Add this into both your client Engine Gem and the application that uses your Engine Gem where MyGoaGem::Base is the base class for your models.
+
+```ruby
+require 'goa'
+require 'goa/database_cleaner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    GOA::DatabaseCleaner.truncate_database(MyGoaGem::Base)
+  end
+
+  config.before(:each) do
+    GOA::DatabaseCleaner.begin_transaction(MyGoaGem::Base)
+  end
+
+  config.after(:each) do
+    GOA::DatabaseCleaner.end_transaction(MyGoaGem::Base)
+  end
+
+  # ...
+end
+```
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/goa.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'goa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "goa"
+  spec.version       = GOA::VERSION
+  spec.authors       = ["Michael Pearce"]
+  spec.email         = ["michael.pearce@bookrenter.com"]
+  spec.description   = %q{GOA utilities}
+  spec.summary       = %q{Gem Oriented Architecture - Build a Rails Engine with ActiveRecord models}
+  spec.homepage      = ""
+  spec.license       = "Proprietary"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "database_cleaner", "~> 0.8.0"
+end

data/lib/goa.rb

@@ -0,0 +1,3 @@
+require "goa/version"
+require "goa/rake_tasks"
+require "goa/config"

data/lib/goa/config.rb

@@ -0,0 +1,21 @@
+require 'erb'
+
+class GOA::Config
+  class << self
+    def database_config_file_path(engine_root)
+      path = "config/database.yml"
+
+      path = "#{path}.#{Rails.env}" if File.exists?(File.join(engine_root, "#{path}.#{Rails.env}"))
+
+      File.join(engine_root, path)
+    end
+
+    def database_config(engine_root, config_env_override_key = nil)
+      config_override_env = config_env_override_key && Rails.application.config.respond_to?(config_env_override_key) && Rails.application.config.send(config_env_override_key)
+
+      env_key = config_override_env || Rails.env
+
+      YAML.load(ERB.new(File.read(database_config_file_path(engine_root))).result)[env_key].symbolize_keys
+    end
+  end
+end

data/lib/goa/database_cleaner.rb

@@ -0,0 +1,47 @@
+begin
+  require 'database_cleaner'
+  require 'database_cleaner/active_record/truncation'
+  require 'database_cleaner/active_record/transaction'
+rescue LoadError => e
+  raise LoadError, "You must have the DatabaseCleaner Gem available to require 'goa/database_cleaner'"
+end
+
+module GOA
+  class DatabaseCleaner
+    class Truncation < ::DatabaseCleaner::ActiveRecord::Truncation
+      def initialize(connection_class)
+        @connection_class = connection_class
+        super()
+      end
+
+      def connection_klass
+        @connection_class
+      end
+    end
+
+    class Transaction < ::DatabaseCleaner::ActiveRecord::Transaction
+      def initialize(connection_class)
+        @connection_class = connection_class
+        super()
+      end
+
+      def connection_klass
+        @connection_class
+      end
+    end
+
+    class << self
+      def truncate_database(connection_class)
+        ::GOA::DatabaseCleaner::Truncation.new(connection_class).clean
+      end
+
+      def begin_transaction(connection_class)
+        ::GOA::DatabaseCleaner::Transaction.new(connection_class).start
+      end
+
+      def end_transaction(connection_class)
+        ::GOA::DatabaseCleaner::Transaction.new(connection_class).clean
+      end
+    end
+  end
+end

data/lib/goa/rake_tasks.rb

@@ -0,0 +1,134 @@
+require 'rake'
+
+class Rake::Task
+  def already_invoked?
+    @already_invoked
+  end
+end
+
+require 'erb'
+
+class Object
+  # allow database configuration to be changed during db:test:prepare
+  def reset_current_config
+    @current_config = nil
+  end
+end
+
+
+class GOA::RakeTasks
+  attr_reader :engine_task_namespace, :engine_root, :application_config_database_environment, :schema_format
+
+  def initialize(engine_task_namespace = nil, options = {})
+    @engine_task_namespace = engine_task_namespace || caller.first.match(/.*\/([^:.]+)/)[1]
+    @engine_root = options[:engine_root] || File.join(caller.first.match(/(.*)\//)[1], '..', '..')
+    @application_config_database_environment = options[:application_config_database_environment]
+    @schema_format = options[:schema_format]
+  end
+
+  def add_rake_tasks()
+    extend Rake::DSL
+
+    namespace engine_task_namespace do
+      # https://gist.github.com/rafaelchiti/5575309
+      namespace(:db) do
+        %w(drop create migrate rollback seed version schema:load schema:dump test:prepare).each do |name|
+          desc "Run #{name} for #{engine_task_namespace} gem"
+          task name do
+            invoke_engine_task("db:#{name}")
+          end
+        end
+      end
+
+      task :startup do
+        @orig_db = Rails.application.config.paths['db']
+        @orig_db_migrate = Rails.application.config.paths['db/migrate']
+        @orig_db_seeds = Rails.application.config.paths['db/seeds']
+        @orig_db_config = Rails.application.config.paths['config/database']
+        @orig_schema_format = ActiveRecord::Base.schema_format
+        @orig_env_schema = ENV['SCHEMA']
+        @orig_env_structure = ENV['DB_STRUCTURE']
+      end
+
+      task :setup do
+        %w(db:load_config db:structure:load db:test:purge db:schema:load db:schema:dump db:test:load_structure db:test:clone_structure).each do |name|
+          Rake::Task[name].reenable
+        end
+
+        {
+          'db' => 'db',
+          'db/migrate' => 'db/migrate',
+          'db/seeds' => 'db/seeds.rb',
+          'config/database' => database_config_file_path
+        }.each do |key, value|
+          Rails.application.config.paths[key] = [File.join(engine_root, value)]
+        end
+        ActiveRecord::Base.schema_format = schema_format if schema_format
+
+        ENV['SCHEMA'] = File.join(engine_root, 'db', 'schema.rb')
+        ENV['DB_STRUCTURE'] = File.join(engine_root, 'db', 'structure.sql')
+
+        reset_current_config
+        Rake::Task["db:load_config"].execute # load config after we made our changes
+
+        @orig_connection_config = ActiveRecord::Base.connection_config if ActiveRecord::Base.connected? and @orig_connection_config.nil?
+        ActiveRecord::Base.establish_connection(engine_database_config)
+      end
+
+      task :teardown do
+        ActiveRecord::Base.establish_connection(@orig_connection_config) if @orig_connection_config
+
+        {
+          'db' => @orig_db,
+          'db/migrate' => @orig_db_migrate,
+          'db/seeds' => @orig_db_seeds,
+          'config/database' => @orig_db_config
+        }.each do |key, value|
+          Rails.application.config.paths[key] = value
+        end
+        ActiveRecord::Base.schema_format = @orig_schema_format
+
+        ENV['SCHEMA'] = @orig_env_schema
+        ENV['DB_STRUCTURE'] = @orig_env_structure
+
+        Rake::Task["db:load_config"].tap { |t| t.execute; t.reenable } # restore original config after done
+
+        reset_current_config
+      end
+    end
+
+
+    # Make tasks that invoke both supply client and bomb db tasks
+    %w(db:drop db:create db:migrate db:rollback db:seed db:version db:schema:load db:schema:dump db:test:prepare).each do |name|
+      desc "Run #{name} for app and model gems"
+      task "app:#{name}" => ["#{engine_task_namespace}:#{name}", name]
+
+      task "#{engine_task_namespace}:#{name}" => ["#{engine_task_namespace}:startup", "#{engine_task_namespace}:setup"] do
+        Rake::Task["#{engine_task_namespace}:setup"].reenable
+        Rake::Task["#{engine_task_namespace}:teardown"].execute
+      end
+    end
+  end
+
+  private
+
+  def engine_database_config
+    @database_config ||= ::GOA::Config.database_config(engine_root, application_config_database_environment)
+  end
+
+  def database_config_file_path
+    full_path = ::GOA::Config.database_config_file_path(engine_root)
+
+    relative_path = full_path[engine_root.length..-1].gsub(/^\/?/, '')
+
+    relative_path
+  end
+
+  def invoke_engine_task(name)
+    already_invoked = Rake::Task[name].already_invoked?
+
+    Rake::Task[name].execute # use execute to run even if run before
+
+    Rake::Task[name].reenable unless already_invoked # reenable task if it wasn't run before our execute
+  end
+end

data/lib/goa/version.rb

@@ -0,0 +1,3 @@
+module GOA
+  VERSION = "0.0.6"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: goa
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Michael Pearce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: GOA utilities
+email:
+- michael.pearce@bookrenter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- goa.gemspec
+- lib/goa.rb
+- lib/goa/config.rb
+- lib/goa/database_cleaner.rb
+- lib/goa/rake_tasks.rb
+- lib/goa/version.rb
+homepage: ''
+licenses:
+- Proprietary
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Gem Oriented Architecture - Build a Rails Engine with ActiveRecord models
+test_files: []