sinatra_cyclist 0.0.1 → 0.0.2

data/README.md

@@ -1,7 +1,5 @@
 # SinatraCyclist
 
-TODO: Write a gem description
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +16,76 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+* For classic applications, require the gem and specify the routes you want to cycle through.
+    ```ruby
+    require "sinatra"
+    require "sinatra/cyclist"
+
+    set :routes_to_cycle_through, [:page_1, :page_2]
+
+    get "/page_1" do
+      "Page 1"
+    end
+
+    get "/page_2" do
+      "Page 2"
+    end
+    ```
+
+* For modular applications, require the gem, explicitly register the extension, and specify the routes.
+    ```ruby
+    require "sinatra/base"
+    require "sinatra/cyclist"
+
+    class MyApp < Sinatra::Base
+      register Sinatra::Cyclist
+
+      set :routes_to_cycle_through, [:page_1, :page_2]
+
+      get "/page_1" do
+        "Page 1"
+      end
+
+      get "/page_2" do
+        "Page 2"
+      end
+    end
+    ```
+
+Then visit the http://localhost:4567/_cycle to start cycling!
+
+### Dashing
+If you are using [dashing](https://github.com/Shopify/dashing), update your `config.ru`
+
+```ruby
+require "sinatra/cyclist"
+require 'dashing'
+
+configure do
+  set :auth_token, 'YOUR_AUTH_TOKEN'
+
+  helpers do
+    def protected!
+     # Put any authentication code you want in here.
+     # This method is run before accessing any resource.
+    end
+  end
+end
+
+map Sinatra::Application.assets_prefix do
+  run Sinatra::Application.sprockets
+end
+
+set :routes_to_cycle_through, [:dashboard_1, :dashboard_2]
+
+run Sinatra::Application
+```
+
+* Require `sinatra_cyclist` before `dashing` otherwise you will see this error:
+
+    > No such file or directory - sample/dashboards/_cycle.erb
+
+* Set the `routes_to_cycle_through` before running the application.
 
 ## Contributing
 

data/examples/classic_application.rb

@@ -0,0 +1,12 @@
+require "sinatra"
+require "sinatra/cyclist"
+
+set :routes_to_cycle_through, [:page_1, :page_2]
+
+get "/page_1" do
+  "Page 1"
+end
+
+get "/page_2" do
+  "Page 2"
+end

data/examples/config.ru

@@ -0,0 +1,2 @@
+require "./modular_application"
+run MyApp

data/examples/modular_application.rb

@@ -0,0 +1,16 @@
+require "sinatra/base"
+require "sinatra/cyclist"
+
+class MyApp < Sinatra::Base
+  register Sinatra::Cyclist
+
+  set :routes_to_cycle_through, [:page_1, :page_2]
+
+  get "/page_1" do
+    "Page 1"
+  end
+
+  get "/page_2" do
+    "Page 2"
+  end
+end

data/lib/sinatra/cyclist/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Cyclist
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/sinatra/cyclist.rb

@@ -5,13 +5,16 @@ module Sinatra
   module Cyclist
     def self.registered(app)
       app.enable :sessions
+      app.set :routes_to_cycle_through, []
 
       app.get "/_cycle" do
+        return if settings.routes_to_cycle_through.empty?
+
         page_index = session[:_cycle_page_index] || -1
         session[:_cycle_page_index] = page_index + 1
 
-        number_of_views = settings.views.length
-        page = settings.views[session[:_cycle_page_index] % number_of_views]
+        number_of_routes = settings.routes_to_cycle_through.length
+        page = settings.routes_to_cycle_through[session[:_cycle_page_index] % number_of_routes]
 
         session[:_cycle_duration] ||= params[:duration] || 3
 
@@ -29,5 +32,5 @@ module Sinatra
     end
   end
 
-  Sinatra::Base.register Cyclist
+  register Cyclist
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra_cyclist
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-24 00:00:00.000000000 Z
+date: 2012-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -39,12 +39,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/classic_application.rb
+- examples/config.ru
+- examples/modular_application.rb
 - lib/sinatra/cyclist.rb
 - lib/sinatra/cyclist/version.rb
 - sinatra_cyclist.gemspec
-- spec/lib/cyclist_spec.rb
-- spec/spec_helper.rb
-- spec/support/classic_application.rb
 homepage: https://github.com/vrish88/sinatra_cyclist
 licenses: []
 post_install_message: 
@@ -69,7 +69,4 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Sinatra can ride a bicycle over and over and over again
-test_files:
-- spec/lib/cyclist_spec.rb
-- spec/spec_helper.rb
-- spec/support/classic_application.rb
+test_files: []

data/spec/lib/cyclist_spec.rb

@@ -1,9 +0,0 @@
-require "spec_helper"
-
-module Sinatra
-  describe Cyclist do
-    it "registers itself as an extension" do
-      Base.extensions.should include Sinatra::Cyclist
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,6 +0,0 @@
-require "rspec"
-require "sinatra"
-require "sinatra/cyclist"
-
-Sinatra::Application.environment = :test
-Bundler.require :default, Sinatra::Application.environment

data/spec/support/classic_application.rb

@@ -1,13 +0,0 @@
-require "sinatra"
-require "debugger"
-require_relative "../../lib/sinatra/cyclist"
-
-set :views, [:page_1, :page_2]
-
-get "/page_1" do
-  "Page 1"
-end
-
-get "/page_2" do
-  "Page 2"
-end