excursion 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91ab81cf91d566addc17aa5963965138a1c6592a
+  data.tar.gz: 32aae702c9c69c58bbb4c420e606a50990e51d5f
+SHA512:
+  metadata.gz: cb034cdfc374f4266221b176d3cf786981b7af4287446340530933ae097f9e8ba3f13df52b0bd7460a7bf3a1e5af72d241984a2df26c1674fdced47f6b98c376
+  data.tar.gz: eb5cfb2d550eee50c5b26db1ef89a5f188846dd3bebe29d46c89c430c219f3b3d58c16f6ecc10a02c78ac2769e5b8031a6f447b0b33eecca125d14917d4e8996

data/lib/excursion/configuration.rb

@@ -0,0 +1,86 @@
+module Excursion
+  class Configuration
+    DEFAULT_CONFIGURATION_OPTIONS = {
+      # TODO
+        # exclude_pattern: to exclude certain routes from being shared
+        # include_pattern: to only include certain routes
+      default_url_options: {}
+    }
+
+    #attr_reader *DEFAULT_CONFIGURATION_OPTIONS.keys
+
+    #DEFAULT_CONFIGURATION_OPTIONS.keys.each do |key|
+    #  define_method "#{key.to_s}=" do |val|
+    #    @changed[key] = [send(key), val]
+    #    instance_variable_set "@#{key.to_s}", val
+    #  end
+    #end
+
+    def method_missing(meth, *args)
+      if meth.to_s.match(/\A(.*)=\Z/)
+        @changed[$1] = [send($1), *args]
+        instance_variable_set "@#{$1.to_s}", *args
+      else
+        instance_variable_get "@#{meth}"
+      end
+    end
+
+    # Returns a hash of all the changed keys and values after being reconfigured
+    def changed
+      @changed = {}
+      to_hash.each { |key,val| @changed[key] = [@saved_state[key], val] if @saved_state[key] != val }
+      @changed
+    end
+
+    # Check whether a key was changed after being reconfigured
+    def changed?(key)
+      changed.has_key?(key)
+    end
+
+    # Pass arguments and/or a block to configure the available options
+    def configure(args={}, &block)
+      save_state
+      configure_with_args args
+      configure_with_block &block if block_given?
+      self
+    end
+
+    # Accepts arguments which are used to configure available options
+    def configure_with_args(args)
+      args.select { |k,v| DEFAULT_CONFIGURATION_OPTIONS.keys.include?(k) }.each do |key,val|
+        instance_variable_set "@#{key.to_s}", val
+      end
+    end
+
+    # Accepts a block which is used to configure available options
+    def configure_with_block(&block)
+      self.instance_eval(&block) if block_given?
+    end
+
+    # Saves a copy of the current state, to be used later to determine what was changed
+    def save_state
+      @saved_state = clone.to_hash
+      @changed = {}
+    end
+
+    def to_hash
+      h = {}
+      DEFAULT_CONFIGURATION_OPTIONS.keys.each do |key|
+        h[key] = instance_variable_get "@#{key.to_s}"
+      end
+      h
+    end
+    alias_method :to_h, :to_hash
+
+    protected
+
+    def initialize
+      DEFAULT_CONFIGURATION_OPTIONS.each do |key,val|
+        instance_variable_set "@#{key.to_s}", val
+      end
+      save_state
+      super
+    end
+
+  end
+end

data/lib/excursion/datasources/datasource.rb

@@ -0,0 +1,14 @@
+module Excursion
+  module Datasources
+    class Datasource
+      
+      def read(key); end
+      alias_method :get, :read
+      def write(key, value); end
+      alias_method :set, :write
+      def delete(key); end
+      alias_method :unset, :delete
+
+    end
+  end
+end

data/lib/excursion/datasources/file.rb

@@ -0,0 +1,53 @@
+require 'yaml'
+require 'excursion/datasources/datasource'
+
+module Excursion
+  module Datasources
+    class File < Datasource
+
+      def read(key)
+        read_file[key.to_s]
+      end
+      alias_method :get, :read
+      
+      def write(key, value)
+        current = read_file
+        current[key.to_s] = value
+        write_file(current)
+        current[key.to_s]
+      end
+      alias_method :set, :write
+
+      def delete(key)
+        current = read_file
+        deleted = current.delete(key.to_s)
+        write_file(current)
+        deleted
+      end
+      alias_method :unset, :delete
+
+      protected
+
+      def initialize(path=nil)
+        path = Excursion.configuration.datasource_file
+        @path = ::File.expand_path(path)
+      rescue
+        raise "Could not initialize the File datasource. Make sure you have properly configured your datasource"
+      end
+
+      def exists?
+        ::File.exists(@path)
+      end
+
+      def read_file
+        YAML.load_file(@path) || {}
+      rescue
+        {}
+      end
+
+      def write_file(results)
+        ::File.open(@path, 'w') { |f| f.write(results.to_yaml)}
+      end
+    end
+  end
+end

data/lib/excursion/helpers/application_helper.rb

@@ -0,0 +1,24 @@
+module Excursion
+  module Helpers
+    class ApplicationHelper
+
+      def routes
+        @application.routes
+      end
+
+      def method_missing(meth, *args)
+        if meth.to_s.match(/\A(#{routes.collect { |name,route| name }.join("|")})_(url|path)\Z/)
+          ActionDispatch::Routing::RouteSet::NamedRouteCollection::UrlHelper.create(routes.get($1.to_sym), @application.default_url_options).call(Rails.application.routes, args)
+        else
+          super
+        end
+      end
+
+      protected
+
+      def initialize(app)
+        @application = app
+      end
+    end
+  end
+end

data/lib/excursion/helpers/helper.rb

@@ -0,0 +1,22 @@
+module Excursion
+  module Helpers
+    module Helper
+      
+      def method_missing(meth, *args)
+        if !(app = Pool.application(meth.to_s)).nil?
+          @application_helpers ||= {}
+          @application_helpers[app.name] ||= ApplicationHelper.new(app)
+        else
+          begin
+            super
+          rescue NoMethodError => e
+            raise "Excursion URL helper method does not exist: #{meth}"
+          end
+        end
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, Excursion::Helpers::Helper
+ActionController::Base.send :helper, Excursion::Helpers::Helper

data/lib/excursion/helpers.rb

@@ -0,0 +1,7 @@
+require 'excursion/helpers/application_helper'
+require 'excursion/helpers/helper'
+
+module Exursion
+  module Helpers
+  end
+end

data/lib/excursion/pool/application.rb

@@ -0,0 +1,61 @@
+module Excursion
+  module Pool
+    class Application
+      attr_reader :name, :default_url_options
+
+      def self.from_cache(cached)
+        new.from_cache(cached)
+      end
+
+      def route(key)
+        routes[key.to_sym]
+      end
+
+      def routes
+        @routes ||= ActionDispatch::Routing::RouteSet::NamedRouteCollection.new
+      end
+
+      def routes=(routes)
+        @routes = ActionDispatch::Routing::RouteSet::NamedRouteCollection.new
+        routes.each do |name, route|
+          @routes.add(name, route)
+        end
+      end
+
+      def set_routes(routes)
+        self.routes = routes
+        self
+      end
+
+      def to_cache
+        {name: @name,
+         routes: Hash[routes.map { |name, route| [name.to_sym, route.path.spec.to_s] }],
+         default_url_options: @default_url_options,
+         registered_at: @registered_at
+        }
+      end
+
+      def routes_from_cache(routes)
+        collection = ActionDispatch::Routing::RouteSet::NamedRouteCollection.new
+        routes.each do |name, path|
+          collection.add(name, ActionDispatch::Journey::Route.new(name, Rails.application, ActionDispatch::Journey::Path::Pattern.new(path), {required_defaults: []}))
+        end
+        collection
+      end
+
+      def from_cache(cached={})
+        @name = cached[:name] # required
+        @routes = routes_from_cache(cached[:routes]) if cached.has_key?(:routes)
+        @default_url_options = cached[:default_url_options]
+        @registered_at = (Time.at(cached[:registered_at]) rescue Time.now)
+        self
+      end
+      
+      protected
+
+      def initialize(config={}, routes={})
+        from_cache(config).set_routes(routes)
+      end
+    end
+  end
+end

data/lib/excursion/pool.rb

@@ -0,0 +1,30 @@
+require 'excursion/pool/application'
+
+module Excursion
+  module Pool
+    @@applications = {}
+
+    def self.application(name)
+      return @@applications[name] if @@applications.has_key?(name)
+      
+      app_yaml = datasource.get(name)
+      @@applications[name] = Application.from_cache(app_yaml) unless app_yaml.nil?
+    end
+
+    def self.register_application(app)
+      name = app.class.name.underscore.split("/").first
+      config = {name: name, default_url_options: Excursion.configuration.default_url_options}
+      
+      @@applications[name] = Application.new(config, app.routes.named_routes)
+      datasource.set(name, @@applications[name].to_cache)
+    end
+
+    def self.datasource
+      raise if Excursion.configuration.datasource.nil?
+      require "excursion/datasources/#{Excursion.configuration.datasource.to_s}"
+      @@datasource ||= "Excursion::Datasources::#{Excursion.configuration.datasource.to_s.camelize}".constantize.new
+    rescue
+      raise "Could not initialize your datasource. Make sure you have properly configured it"
+    end
+  end
+end

data/lib/excursion/railtie.rb

@@ -0,0 +1,17 @@
+module Excursion
+  class Railtie < Rails::Railtie
+    config.after_initialize do |app|
+      app.reload_routes!
+      Excursion::Pool.register_application(app)
+    end
+
+    rake_tasks do
+      namespace :excursion do
+        desc "Register this app and it's routes with the route pool"
+        task :register => :environment do
+          Excursion::Pool.register_application(Rails.application)
+        end
+      end
+    end
+  end
+end

data/lib/excursion/version.rb

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

data/lib/excursion.rb

@@ -0,0 +1,17 @@
+require 'excursion/configuration'
+
+module Excursion
+  @@configuration = Excursion::Configuration.new
+
+  def self.configure(&block)
+    @@configuration.configure &block
+  end
+
+  def self.configuration
+    @@configuration
+  end
+end
+
+require 'excursion/pool'
+require 'excursion/helpers'
+require 'excursion/railtie'

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+# TODO: specs!

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: excursion
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Rebec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: rspec-rails
+  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: Provides a pool of routes into which applications can dump their host
+  information and routing table. Other applications can then utilize application namespaced
+  helper methods for redirecting, etc. between apps.
+email:
+- mark@markrebec.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/excursion/pool.rb
+- lib/excursion/pool/application.rb
+- lib/excursion/railtie.rb
+- lib/excursion/configuration.rb
+- lib/excursion/datasources/file.rb
+- lib/excursion/datasources/datasource.rb
+- lib/excursion/helpers/application_helper.rb
+- lib/excursion/helpers/helper.rb
+- lib/excursion/helpers.rb
+- lib/excursion/version.rb
+- lib/excursion.rb
+- spec/spec_helper.rb
+homepage: http://github.com/markrebec/excursion
+licenses: []
+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.0.rc.2
+signing_key: 
+specification_version: 4
+summary: Route pooling to share routes between applications
+test_files:
+- spec/spec_helper.rb
+has_rdoc: