junctions 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c9ff0e5eba4046ba01c51716d02ef558f6d76d614569d3d07c0a7d2386187c1
-  data.tar.gz: a72f7cd80a90bd1f4df1813b3b4b25a0ed6f36cfe9b67b115db0bd1b0143eee7
+  metadata.gz: 46968c8faf2deace067f63346169d31d0edeb70364bee6307aa3e16e1a58d654
+  data.tar.gz: e115486975b7d8642ea174899a85164cbba670420b8521ded913f29ddfebab10
 SHA512:
-  metadata.gz: 4b196f9d119271254f7e6f414ea9967a738b4b4e68dad08527964fef5cfced61dc30a7120489d358d576055d0201f6f46cefda54ff4e6f8840bc6b727fa09c77
-  data.tar.gz: 75209ec68e5f176183ba356ab6e34bffae6f86e36005498736336485f2a3a5276e16b007799248b608e5195868ec3a3dbf6d95eaa7776fbe380a50fe33a95331
+  metadata.gz: 772a897be5bc58ff2f5a48b725c4d4baf5a62e241ff5cf810569b28d4abe5d1fbf77df2879a94c0431d06ae3cff369fa5642f14ca20f1b56087ce7fc584e04b3
+  data.tar.gz: e6d4a97ce751b35da00e77bd1cf9296f10900e273118b3494c0fc8e0eea8987fc29d935eb1b9c9fdc7b57735888d03cd60629abadd451eed8c825db6b42ef7c4

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in junctions.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    junctions (0.0.2)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    config_files (0.1.3)
+      activesupport
+    docile (1.3.0)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    minitest (5.11.3)
+    rake (12.3.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  config_files
+  junctions!
+  minitest
+  rake
+  simplecov
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2010 Paul McKibbin
+
+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,49 @@
+# Junctions
+Layered junctioning for Rails. Feature flags done right.
+
+Junctions works by enabling conditional namespaced module inclusion. What that actually means is that features
+in a module can be enabled or disable by creating them in a particular namespace. For example:
+
+```ruby
+module Core
+  include Junctions
+  def overridden_method
+    puts('You are in core')
+  end
+end
+
+module Wibble
+  def overridden_method
+    puts('Wibble')
+  end
+end
+
+module Wobble
+  def overridden_method
+    puts('Something else')
+  end
+end
+```
+Including Junctions in Core means that if there is a 'junctions' setting as, for example, an environment variable
+```bash
+  junctions=wibble, wobble
+```
+would first load up Core, then Wibble and finally Wobble as modules and include each of them in turn. This has the effect of
+overriding the 'overridden_method' inside Core to display 'Something else' as the message.
+Likewise if the environment variable were:
+```bash
+  junctions=wibble
+```
+This would only include Wibble into the list of namespaces to override Core methods.
+
+Ruby and Rails Versions
+
+Junctions has been built for Ruby 2.5 and Rails 5. Although it was originally built for Ruby 1.8 and Rails 2, 
+because of fundamental changes to later versions of rails and engines in particular, the decision was made to
+track the latest Rails version only.
+
+
+
+
+
+

data/junctions.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+# Maintain your gem's version:
+require 'junctions'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'junctions'
+  s.version     = Rails::Junctions::VERSION
+  s.authors     = ['Paul McKibbin']
+  s.email       = ['pmckibbin@gmail.com']
+  s.homepage    = 'http://blackrat.org'
+  s.summary     = 'Summary of Junctions.'
+  s.description = 'Description of Junctions.'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activesupport', '~> 0'
+
+  s.add_development_dependency 'bundler', '~> 0'
+  s.add_development_dependency 'rake', '~> 0'
+  s.add_development_dependency 'minitest', '~> 0'
+  s.add_development_dependency 'simplecov', '~> 0'
+  s.add_development_dependency 'config_files', '~> 0'
+end

data/lib/junctions/engine.rb

@@ -1,126 +1,46 @@
+require 'active_support/inflector'
 module Junctions
-  class Engine < ::Rails::Engine
-    isolate_namespace Junctions
-
-    @brand_list=nil
+  class Engine
     class << self
-      attr_accessor :brand_list
-
-      def get_initializer_roots(*args)
-        args.map do |arg|
-          root=ENV[arg]
-          root && root.split(',') or nil
-        end.flatten.compact << 'core'
-      end
-
-      def brand_list
-        @brand_list||=get_initializer_roots('brand')
-      end
-    end
-
-
-    private
-    def all_features(&blk)
-      [:cells,:controllers,:decorators,:helpers,:mailers,:models,:notifications,:observers,:policies,:reports].each do |feature|
-        yield feature
-      end
-    end
-
-    def base_config(config)
-      config.paths.add 'lib/brands', eager_load: true, glob: '*'
-      config.paths.add 'lib/brands/lib', eager_load: true, glob: '*'
-      all_features do |feature|
-        config.paths.add "lib/brands/app/#{feature}", eager_load: true, glob: '*'
-        config.paths.add "app/#{feature}", eager_load: true, glob: '*'
-      end
-    end
-
-    def brand_config(config, brand)
-      config.paths.add "lib/brands/#{brand}", eager_load: true, glob: '*'
-      config.paths.add "lib/brands/lib/#{brand}", eager_load: true, glob: '*'
-      all_features do |feature|
-        config.paths.add "lib/brands/app/#{feature}/#{brand}"
-        config.paths.add "app/#{feature}/#{brand}"
-      end
-    end
+      public
+      attr_writer :junction_list, :core
 
-    def view_config(brand)
-      [
-        Pathname.new("app/views/#{brand}").expand_path,
-        Pathname.new("lib/brands/app/views/#{brand}").expand_path
-      ]
-    end
-
-    def for_all_brands_reversed(&blk)
-      brand_list.reverse.each do |brand|
-        yield brand
+      def junction_list
+        @junction_list||=get_initializer_roots('junctions')
       end
-    end
 
-    def for_all_brands(&blk)
-      brand_list.each do |brand|
-        yield brand
+      def core
+        @core||='core'
       end
-    end
-
-    def already_in_root?(app)
-      root.to_s.match app.root.to_s
-    end
-
-    public
-    def brand_list
-      self.class.brand_list
-    end
-
 
-    initializer :load_environment_config, before: :load_environment_hook, group: :all do |app|
-      for_all_brands_reversed do |brand|
-        app.config.paths['config/environments'] << "config/brands/environments/#{brand}"
-        app.config.paths['config/initializers'] << "config/brands/initializers/#{brand}"
-        #TODO This isn't being loaded for the rake db:create, although the rake db:migrate is using it
-        #TODO Find out and fix the config/database, config/routes.rb not loading the latest instance
-        #TODO unless you overwrite it.
-        app.config.paths['config/database'] = "config/brands/databases/#{brand}/database.yml"
-        app.config.paths['config.routes.rb'] = "config/brands/routes/#{brand}/routes.rb"
+      private
+      def get_initializer_roots(*args)
+        args.map do |arg|
+          root=ENV[arg]
+          root && root.split(',') or nil
+        end.flatten.compact << core
       end
-      # app.config.paths['config/database'],old_db='',app.config.paths['config/database']
-      # app.config.paths['config/routes.rb'],old_routes='',app.config.paths['config/routes']
-      # for_all_brands do |brand|
-      #   app.config.paths['config/database'] = "config/brands/databases/#{brand}/database.yml"
-      #   app.config.paths['config.routes.rb'] = "config/brands/routes/#{brand}/routes.rb"
-      # end
-      # app.config.paths['config/database'] << old_db
-      # app.config.paths['config/routes.rb'] << old_routes
-    end
 
-    initializer :append_migrations do |app|
-      unless already_in_root?(app)
-        config.paths['db/migrate'].expanded.each do |expanded_path|
-          app.config.paths['db/migrate'] << expanded_path
-        end
+      def junction_classes
+        junction_list.reverse
       end
-    end
 
-    initializer :add_eager_load_lib do |app|
-      for_all_brands_reversed do |brand|
-        brand_config(app.config,brand)
+      def switch_to_junction(junction_class, base, base_name)
+        name=base_name.gsub("#{core.classify}::", "#{junction_class}::")
+        begin
+          require(name.underscore)
+          base.instance_eval {
+            include name.constantize
+          } if name.gsub(/::[^:]*$/, '').constantize.const_defined?(name.demodulize)
+        rescue Exception => e
+          puts(e.message)
+          puts(e.backtrace)
+        end unless base_name==name
       end
-      base_config(app.config)
-      app.config.paths.add 'lib/brands/app', eager_load: true, glob: '*'
-    end
 
-    initializer :add_brand_view_paths do |app|
-      unless already_in_root?(app)
-        for_all_brands_reversed do |brand|
-          view_config(brand).each do |brand_view|
-            ActiveSupport.on_load(:action_controller){
-              prepend_view_path(brand_view) if respond_to?(:prepend_view_path)
-            }
-            ActiveSupport.on_load(:action_mailer){
-              prepend_view_path(brand_view)
-            }
-          end
-        end
+      public
+      def activate(base, name)
+        junction_classes.each { |junction_class| switch_to_junction(junction_class.classify, base, name) }
       end
     end
   end

data/lib/junctions/version.rb

@@ -1,3 +1,5 @@
-module Junctions
-  VERSION = "0.0.1"
+module Rails
+  module Junctions
+    VERSION = '0.0.3'
+  end
 end

data/lib/junctions.rb

@@ -1 +1,12 @@
+require 'junctions/engine'
 require "junctions/version"
+
+module Junctions
+  class << self
+    delegate :core=, :junction_list=, :activate, to: Junctions::Engine
+
+    def included(base)
+      Junctions::Engine.activate(base, self.name)
+    end
+  end
+end

data/test/junctions_test.rb

@@ -1,7 +1,29 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
 require 'test_helper'
+require 'wibble'
+require 'wobble'
 
-class JunctionsTest < ActiveSupport::TestCase
-  test "truth" do
-    assert_kind_of Module, Junctions
+class Junctions::Test < MiniTest::Spec
+  describe Junctions do
+    it 'is a module' do
+      assert_kind_of Module, Junctions
+    end
+  end
+
+  describe ::Wibble do
+    it 'has to_s overridden' do
+      assert_equal Wibble.new.to_s, 'metal'
+    end
+
+    it 'has a metal method' do
+      assert_equal 'metal included too', Wibble.new.metal
+    end
+  end
+
+  describe ::Wobble do
+    it 'overrides the to_s from metal with its own method' do
+      assert_equal 'plastic included too', Wobble.new.metal
+    end
   end
 end

data/test/lib/common/wibble_extensions.rb

@@ -0,0 +1,14 @@
+module Common
+  module WibbleExtensions
+    include Junctions
+    class << self
+      def included(base)
+        Junctions::activate(base, self.name)
+      end
+    end
+
+    def to_s
+      'wibble_extensions'
+    end
+  end
+end

data/test/lib/metal/wibble_extensions.rb

@@ -0,0 +1,11 @@
+module Metal
+  module WibbleExtensions
+    def to_s
+      'metal'
+    end
+
+    def metal
+      "#{to_s} included too"
+    end
+  end
+end

data/test/lib/plastic/wibble_extensions.rb

@@ -0,0 +1,7 @@
+module Plastic
+  module WibbleExtensions
+    def to_s
+      'plastic'
+    end
+  end
+end

data/test/lib/wibble.rb

@@ -0,0 +1,8 @@
+require 'junctions'
+Junctions::Engine.core = 'common'
+Junctions::Engine.junction_list = ['metal']
+require 'common/wibble_extensions'
+
+class Wibble
+  include Common::WibbleExtensions
+end

data/test/lib/wobble.rb

@@ -0,0 +1,8 @@
+require 'junctions'
+Junctions.core = 'common'
+Junctions.junction_list = ['plastic', 'metal']
+require 'common/wibble_extensions'
+
+class Wobble
+  include Common::WibbleExtensions
+end

data/test/test_helper.rb

@@ -1,17 +1 @@
-# Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
-
-require File.expand_path("../../test/dummy/config/environment.rb",  __FILE__)
-ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]
-ActiveRecord::Migrator.migrations_paths << File.expand_path('../../db/migrate', __FILE__)
-require "rails/test_help"
-
-Rails.backtrace_cleaner.remove_silencers!
-
-# Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
-
-# Load fixtures from the engine
-if ActiveSupport::TestCase.respond_to?(:fixture_path=)
-  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
-end
+require 'minitest/autorun'