sinatra_bicyclist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6dd623dcfeee2a86c6f472b1801b2c07f9e2c9f0
+  data.tar.gz: 64954cb95a7eeb1493fc5b649585eff62100b3b1
+SHA512:
+  metadata.gz: 3d50bfcc4d50c04ab38d240144d64703ee8c02d1befdccf4c83980bbf041fcc24002cb566fd455844857a59c5e23f3f3dbe844baba713fc30480d0cea1d9bb96
+  data.tar.gz: 33e8eddc21a9ae711176fff87920184e2d5cfce469001a46d696eda5dd417fa4cb9cefdb461a8389848889e56bd40e95e463eb48154dd5598da0db9954aa722f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.0.0
+- 1.9.3
+- jruby-19mode
+- rbx-2

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## 0.1.0 - 2014-09-30
+### Added
+- support for more cycle groups
+  now you can specify `routes_to_cycle_through` as a hash
+  then it picks one of the keys and starts cycling all values of given key
+- a "Change Log"
+
+### Changed
+- Changed project name to sinatra_bicyclist

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra_cyclist.gemspec
+gemspec
+
+
+group :development do
+  gem 'pry-byebug', platforms: [:mri_20, :mri_21]
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Lavrisha
+
+MIT License
+
+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,124 @@
+# SinatraBicyclist
+
+This is a fork of SinatraCyclist. It adds functionality to have more than one cycling loops.
+So you can have `/_cycle/apps` and `/_cycle/ops` to loop through different pages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra_bicyclist'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra_bicyclist
+
+Installation into your code depends on how you are using Sinatra.
+
+### Dashing
+If you are using [dashing](https://github.com/Shopify/dashing) update your `config.ru` to look something like:
+
+```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.
+
+### 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
+```
+
+### 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
+```
+
+## Usage
+Now visit `/_cycle` to start cycling!
+
+You can also specify a duration (in seconds) in the params to the cycle action
+
+```
+http://sinatra_app.com/_cycle?duration=10
+```
+
+## Advanced Usage
+
+If you want to have different cycles for different dashboards you can define:
+
+```
+set :routes_to_cycle_through, {
+  applications: [:dash1, :dash2, :dash3],
+  operations: [:dash4, :dash5, :dash6]
+}
+```
+
+Then visiting `/_cycle/applications` will go just through dashboards dash1, dash2 and dash3.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+![](http://24.media.tumblr.com/tumblr_lhgo817Gnw1qf6o97o1_500.jpg)

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end

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/bicyclist.rb

@@ -0,0 +1,39 @@
+require 'sinatra/base'
+require_relative 'bicyclist/version'
+require_relative 'bicyclist/cycler'
+
+module Sinatra
+  module Bicyclist
+    def self.registered(app)
+      app.enable :sessions
+      app.set :routes_to_cycle_through, {}
+      app.set :cycle_duration, 3
+      app.set :cycler, Sinatra::Bicyclist::Cycler.new(app.settings)
+
+      app.get '/_cycle' do
+        session[:_cycle_duration] = params[:duration] if params.has_key?('duration')
+
+        page = settings.cycler.page(session)
+        redirect settings.cycler.group ? "/_cycle/#{page}" : "/#{page}"
+      end
+
+      app.get '/_cycle/:group' do
+        session[:_cycle_duration] = params[:duration] if params.has_key?('duration')
+
+        page = settings.cycler.page(session, params[:group])
+        redirect "/#{page}"
+      end
+
+      app.before do
+        session[:_cycle_duration] ||= settings.cycle_duration
+
+        if group = session.delete(:_cycle)
+          headers["Refresh"] = "#{session[:_cycle_duration]}; url=/_cycle/#{group}"
+          session[:_last_cycle] = group
+        end
+      end
+    end
+  end
+
+  register Bicyclist
+end

data/lib/sinatra/bicyclist/cycler.rb

@@ -0,0 +1,58 @@
+module Sinatra
+  module Bicyclist
+    class Cycler
+      attr_accessor :duration
+
+      def initialize(settings)
+        @settings = settings
+      end
+
+      def routes
+        @settings.routes_to_cycle_through
+      end
+
+      def has_groups?
+        Hash === @settings.routes_to_cycle_through
+      end
+
+      def pages(group = nil)
+        return routes[group.to_sym] if has_group?(group)
+
+        case routes
+          when Array then routes
+          when Hash then routes.keys
+        end
+      end
+
+      def has_group?(name)
+        name && has_groups? && pages.map(&:to_s).include?(name.to_s)
+      end
+
+      def group
+        has_groups?
+      end
+
+      def page_index(session)
+        page_index = session[:_cycle_page_index] || -1
+        session[:_cycle_page_index] = page_index + 1
+      end
+
+      def random_route(session, group)
+        number_of_routes = pages(group).length
+        pages(group)[page_index(session) % number_of_routes]
+      end
+
+      def reset_index(session)
+        session[:_cycle_page_index] = -1
+      end
+
+      def page(session, group = nil)
+        reset_index(session) if group.to_s != session[:_last_cycle].to_s
+        page = random_route(session, group)
+        session[:_cycle] = group || (has_groups? && page)
+        page
+      end
+    end
+
+  end
+end

data/lib/sinatra/bicyclist/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Bicyclist
+    VERSION = '0.1.0'
+  end
+end

data/sinatra_cyclist.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sinatra/bicyclist/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael Lavrisha", 'Michal Cichra']
+  gem.email         = ["michael.lavrisha@gmail.com", 'michal.cichra@gmail.com']
+  gem.description   = %q{Cycle through pages at a regular interval}
+  gem.summary       = %q{Sinatra can ride a bicycle over and over and over again}
+  gem.homepage      = "https://github.com/mikz/sinatra_bicyclist"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sinatra_bicyclist"
+  gem.require_paths = ["lib"]
+  gem.version       = Sinatra::Bicyclist::VERSION
+
+  gem.add_dependency "sinatra"
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack-test'
+end

data/spec/byciclist_spec.rb

@@ -0,0 +1,26 @@
+require 'sinatra'
+require 'sinatra/bicyclist'
+
+set :routes_to_cycle_through, {
+    one: [:foo],
+    two: [:bar, :baz]
+}
+
+RSpec.describe Sinatra::Application do
+
+  context '_cycle' do
+    before { get '/_cycle' }
+    subject(:response) { last_response }
+
+    it { expect(response.status).to eq(302) }
+    it { expect(response.headers).to include('Location' => 'http://example.org/_cycle/one') }
+
+
+    context 'two' do
+      before { get '/_cycle/two' }
+
+      it { expect(response.status).to eq(302) }
+      it { expect(response.headers).to include('Location' => 'http://example.org/bar') }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,90 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rack/test'
+
+require_relative 'support/rack'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  config.include RackSupport
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/rack.rb

@@ -0,0 +1,7 @@
+module RackSupport
+  include Rack::Test::Methods
+
+  def app
+    Sinatra::Application
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: sinatra_bicyclist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Lavrisha
+- Michal Cichra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: 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: rspec
+  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: rack-test
+  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: Cycle through pages at a regular interval
+email:
+- michael.lavrisha@gmail.com
+- michal.cichra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/classic_application.rb
+- examples/config.ru
+- examples/modular_application.rb
+- lib/sinatra/bicyclist.rb
+- lib/sinatra/bicyclist/cycler.rb
+- lib/sinatra/bicyclist/version.rb
+- sinatra_cyclist.gemspec
+- spec/byciclist_spec.rb
+- spec/spec_helper.rb
+- spec/support/rack.rb
+homepage: https://github.com/mikz/sinatra_bicyclist
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Sinatra can ride a bicycle over and over and over again
+test_files:
+- spec/byciclist_spec.rb
+- spec/spec_helper.rb
+- spec/support/rack.rb