excursion 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e63fb8e58489f77a34238d04ea53e2909fddc803
-  data.tar.gz: 75fc64f54f019ca6b91195a6dc6c295403c3709e
+  metadata.gz: f3dfd7605be2886786008e1c04475bf20279c51d
+  data.tar.gz: 5ff9b50daa9541d28268394c45dd3293d6e176f0
 SHA512:
-  metadata.gz: 90985c4e624e2437261f1aeee8b7864faac53e3f4ae28c1873a88c2430efb72d446c962de8e6bdc59636969e4871ea131bac900de7ee333e0fc0b1c30bf1f06a
-  data.tar.gz: 337a635cb88386c52edec0e9c9ad421ded78b9a2bf0f5dafa9d8fb58d9cacd9d2371cc7b54f405790b28d62768d6f166e00e6941115c766cab07ac0584ef7c08
+  metadata.gz: 4b61c03942b8842cfe658091e496586977d9d2e8c6c2c7e8be428a90d684da786272983b0d780936172d8ad06f5bd8d9c1352b45313fc5750f7c4797184f6522
+  data.tar.gz: e2945a3964b874db4877b02c4b66c9b7ab5d1134d6230568016f323e04f6b5e0d6ff3b82e426224aa6010b5f962ec6e0071d58cad46fb63076dc173e33d4d3fc

data/lib/excursion/configuration.rb

@@ -6,7 +6,7 @@ module Excursion
         # include_pattern: to only include certain routes
       register_app: true, # whether or not to register the app automatically on init
       default_url_options: {}, # default_url_options used when building routes for this app
-      retry_limit: 3 # retry limit for datasources that user remote servers
+      retry_limit: 3 # retry limit for datastores that user remote servers
     }
 
     #attr_reader *DEFAULT_CONFIGURATION_OPTIONS.keys

data/lib/excursion/{datasources/datasource.rb → datastores/datastore.rb}

@@ -1,6 +1,6 @@
 module Excursion
-  module Datasources
-    class Datasource
+  module Datastores
+    class Datastore
       
       def read(key); end
       alias_method :get, :read

data/lib/excursion/{datasources → datastores}/file.rb

@@ -1,9 +1,9 @@
 require 'yaml'
-require 'excursion/datasources/datasource'
+require 'excursion/datastores/datastore'
 
 module Excursion
-  module Datasources
-    class File < Datasource
+  module Datastores
+    class File < Datastore
 
       def read(key)
         read_file[key.to_s]
@@ -28,14 +28,11 @@ module Excursion
 
       protected
 
-      def initialize(path=nil)
-        path ||= Excursion.configuration.datasource_file
-        raise DatasourceConfigurationError, "You must configure the :file datasource with a datasource_file path" if path.nil?
+      def initialize(path)
+        raise DatastoreConfigurationError if path.nil? || path.to_s.empty?
         @path = ::File.expand_path(path)
-      rescue DatasourceConfigurationError => e
-        raise e
       rescue
-        raise DatasourceConfigurationError, "Could not initialize the :file datasource. Make sure you have properly configured the datasource_file path"
+        raise DatastoreConfigurationError, "Could not initialize the :file datastore with path: '#{path}'"
       end
 
       def exists?
@@ -52,7 +49,7 @@ module Excursion
         FileUtils.mkpath(::File.dirname(@path))
         ::File.open(@path, 'w') { |f| f.write(results.to_yaml)}
       rescue
-        raise DatasourceConfigurationError, "Could not write to the excursion route pool file: #{@path}"
+        raise DatastoreConfigurationError, "Could not write to the excursion route pool file: #{@path}"
       end
     end
   end

data/lib/excursion/{datasources → datastores}/memcache.rb

@@ -1,10 +1,10 @@
 require 'dalli'
-require 'excursion/datasources/datasource'
+require 'excursion/datastores/datastore'
 require 'excursion/exceptions/memcache'
 
 module Excursion
-  module Datasources
-    class Memcache < Datasource
+  module Datastores
+    class Memcache < Datastore
 
       def read(key)
         @client.get(key.to_s)
@@ -14,14 +14,15 @@ module Excursion
       alias_method :get, :read
 
       def write(key, value)
-        @client.set(key.to_s, value)
+        value if @client.set(key.to_s, value)
       rescue Dalli::RingError => e
         rescue_from_dalli_ring_error(e) && retry
       end
       alias_method :set, :write
 
       def delete(key)
-        @client.delete(key)
+        value = @client.get(key)
+        value if @client.delete(key)
       rescue Dalli::RingError => e
         rescue_from_dalli_ring_error(e) && retry
       end
@@ -29,9 +30,8 @@ module Excursion
 
       protected
 
-      def initialize(server=nil)
-        server ||= Excursion.configuration.memcache_server
-        raise MemcacheConfigurationError, "You must configure the :memcache datasource with a memcache_server" if server.nil?
+      def initialize(server)
+        raise MemcacheConfigurationError, "Memcache server cannot be nil" if server.nil? || server.to_s.empty?
         @client = Dalli::Client.new(server, {namespace: "excursion"})
       end
 
@@ -47,7 +47,7 @@ module Excursion
           raise MemcacheServerError, "Excursion memcache server is down! Retried #{retries} times."
         end
 
-        STDERR.puts "Excursion memcache server has gone away! Retrying..."
+        #STDERR.puts "Excursion memcache server has gone away! Retrying..."
         sleep 1 # give it a chance to come back
         @dalli_retries += 1
       end

data/lib/excursion/exceptions/datastores.rb

@@ -0,0 +1,7 @@
+module Excursion
+  class DatastoreError < Error; end
+  class NoDatastoreError < DatastoreError; end
+  class InvalidDatastoreError < DatastoreError; end
+
+  class DatastoreConfigurationError < DatastoreError; end
+end

data/lib/excursion/helpers/application_helper.rb

@@ -20,6 +20,8 @@ module Excursion
         end
       end
 
+      protected
+
       def app_exists?(app_name)
         !excursion_app(app_name).nil?
       end

data/lib/excursion/helpers/url_helper.rb

@@ -10,6 +10,8 @@ module Excursion
       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)
+          # Playing with getting Rails3 working
+          #ActionDispatch::Http::URL.url_for(@application.default_url_options.merge({path: replaced_path(routes.get($1.to_sym), args) }))
         else
           super
         end
@@ -20,6 +22,15 @@ module Excursion
       def initialize(app)
         @application = app
       end
+
+      # Playing with getting Rails3 working
+      #def replaced_path(route, args)
+      #  path = route.path.spec.to_s.dup
+      #  route.required_parts.zip(args) do |part, arg|
+      #    path.gsub!(/(\*|:)#{part}/, Journey::Router::Utils.escape_fragment(arg.to_param))
+      #  end
+      #  path
+      #end
     end
   end
 end

data/lib/excursion/pool/application.rb

@@ -4,7 +4,7 @@ module Excursion
       attr_reader :name, :default_url_options
 
       def self.from_cache(cached)
-        new.from_cache(cached)
+        new(cached[:name], cached)
       end
 
       def route(key)
@@ -16,6 +16,8 @@ module Excursion
       end
 
       def routes=(routes)
+        return @routes = routes if routes.is_a?(ActionDispatch::Routing::RouteSet::NamedRouteCollection)
+        raise ArgumentError, 'routes must be a Hash or NamedRouteCollection' unless routes.is_a?(Hash)
         @routes = ActionDispatch::Routing::RouteSet::NamedRouteCollection.new
         routes.each do |name, route|
           @routes.add(name, route)
@@ -24,38 +26,64 @@ module Excursion
 
       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
+        {
+          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 from_cache(cached)
+        @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)
+      end
+      
+      protected
+
+      def initialize(name, config, routes=nil)
+        @name = name
+        from_cache(config)
+        set_routes(routes) unless routes.nil?
+      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: []}))
+          collection.add(name, journey_route(name, Rails.application, journey_path(path), {required_defaults: []}))
         end
         collection
       end
+      
+      def journey_route(name, app, path, options)
+        journey_route_class.new(name, app, path, options)
+      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
+      def journey_route_class
+        if Excursion.rails3?
+          Journey::Route
+        elsif Excursion.rails4?
+          ActionDispatch::Journey::Route
+        end
       end
       
-      protected
+      def journey_path(path)
+        journey_path_class.new(path)
+      end
 
-      def initialize(config={}, routes={})
-        from_cache(config).set_routes(routes)
+      def journey_path_class
+        if Excursion.rails3?
+          Journey::Path::Pattern
+        elsif Excursion.rails4?
+          ActionDispatch::Journey::Path::Pattern
+        end
       end
+
+    
     end
   end
 end

data/lib/excursion/pool.rb

@@ -1,6 +1,6 @@
 require 'excursion/pool/application'
 require 'excursion/exceptions/pool'
-require 'excursion/exceptions/datasources'
+require 'excursion/exceptions/datastores'
 
 module Excursion
   module Pool
@@ -9,33 +9,40 @@ module Excursion
     def self.application(name)
       return @@applications[name] if @@applications.has_key?(name)
       
-      app_yaml = datasource.get(name)
+      app_yaml = datastore.get(name)
       @@applications[name] = Application.from_cache(app_yaml) unless app_yaml.nil?
     end
 
     def self.register_application(app)
+      raise ArgumentError, "app must be an instance of Rails::Application" unless app.is_a?(Rails::Application)
+      
       name = app.class.name.underscore.split("/").first
-      config = {name: name, default_url_options: Excursion.configuration.default_url_options}
+      config = {default_url_options: Excursion.configuration.default_url_options}
       
-      @@applications[name] = Application.new(config, app.routes.named_routes)
-      datasource.set(name, @@applications[name].to_cache)
+      @@applications[name] = Application.new(name, config, app.routes.named_routes)
+      datastore.set(name, @@applications[name].to_cache)
     end
 
     def self.remove_application(app)
+      raise ArgumentError, "app must be an instance of Rails::Application" unless app.is_a?(Rails::Application)
+      
       name = app.class.name.underscore.split("/").first
-      datasource.delete(name)
+      datastore.delete(name)
       @@applications.delete(name)
     end
 
-    def self.datasource
-      raise NoDatasourceError, "You must configure excursion with a datasource." 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 NoDatasourceError => e
-      #raise e
-    rescue StandardError => e
-      raise e
-      #raise InvalidDatasourceError, "Could not initialize your datasource. Make sure you have properly configured it"
+    def self.datastore
+      raise NoDatastoreError, "You must configure excursion with a datastore." if Excursion.configuration.datastore.nil?
+      require "excursion/datastores/#{Excursion.configuration.datastore.to_s}"
+
+      case Excursion.configuration.datastore.to_sym
+      when :file
+        raise DatastoreConfigurationError, "You must configure the :file datastore with a datastore_file path" if Excursion.configuration.datastore_file.nil?
+        @@datastore ||= Excursion::Datastores::File.new(Excursion.configuration.datastore_file)
+      when :memcache
+        raise MemcacheConfigurationError, "You must configure the :memcache datastore with a memcache_server" if Excursion.configuration.memcache_server.nil?
+        @@datastore ||= Excursion::Datastores::Memcache.new(Excursion.configuration.memcache_server)
+      end
     end
   end
 end

data/lib/excursion/version.rb

@@ -1,3 +1,3 @@
 module Excursion
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/excursion.rb

@@ -11,6 +11,14 @@ module Excursion
   def self.configuration
     @@configuration
   end
+  
+  def self.rails3?
+    Rails::VERSION::MAJOR == 3
+  end
+  
+  def self.rails4?
+    Rails::VERSION::MAJOR == 4
+  end
 end
 
 require 'excursion/pool'

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end