bicycle 0.0.1 → 0.1.0

data/Gemfile

@@ -10,6 +10,4 @@ group :development do
   gem "yard", "~> 0.6.0"
   gem "bundler"
   gem "jeweler", "~> 1.6.4"
-  gem "simplecov"
-  gem 'turn', "~> 0.9.5"
 end

data/Gemfile.lock

@@ -1,21 +1,13 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    ansi (1.4.2)
     git (1.2.5)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
     minitest (3.0.1)
-    multi_json (1.3.6)
     rake (0.9.2.2)
-    simplecov (0.6.4)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
-    turn (0.9.5)
-      ansi
     yard (0.6.8)
 
 PLATFORMS
@@ -25,6 +17,4 @@ DEPENDENCIES
   bundler
   jeweler (~> 1.6.4)
   minitest
-  simplecov
-  turn (~> 0.9.5)
   yard (~> 0.6.0)

data/README.md

@@ -1,7 +1,7 @@
 bicycle
 =======
 
-A conveniance gem for cycling through a set of values, much like the ['cycle'](http://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-cycle) functionality found in Rails, but is independant of which framework you use so will run in Sinatra, Padrino or straight up Ruby itself.  
+A convenience gem for cycling through a set of values, ported from the ['cycle'](http://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-cycle) functionality found in Rails. It is independent of which framework you use so will run in Sinatra, Padrino or straight up Ruby itself.
 
 Installation:
 -------------
@@ -19,18 +19,56 @@ gem 'bicycle'
 Usage
 -----
 
-To use, call the cycle function like so 'Bicycle.cycle("Foo", "Bar", "Huh?")' with a set of values you wish to cycle through.
+Add the following to your app.rb file:
+
+```ruby
+include Bicycle
+```
+
+To use, call the cycle function with a set of values you wish to cycle through.
+
+```ruby
+<%= cycle("odd", "even") %>
+```
+
+For example:
+
+```ruby
+<% @items.each do |item| %>
+  <tr class="<%= cycle("odd", "even") %>">
+    <td>item</td>
+  </tr>
+<% end %>
+```
+
+If you want to call multiple instances of the cycle function, you can by specifying a name attribute, like so: '
+
+```ruby
+<%= cycle("red", "green", "blue", :name => "colours") %>
+```
+
+You can also reset a given cycle by calling:
+
+```ruby
+<% reset_cycle("colours") %>
+```
 
 For example:
 
 ```ruby
-<table>
 <% @items.each do |item| %>
- <tr class="<%= Bicycle.cycle("odd", "even") %>">
-   <td>item</td>
- </tr>
+  <tr class="<%= cycle("odd", "even", :name => "row_class") -%>">
+    <td>
+      <% item.values.each do |value| %>
+        <%# Create a named cycle "colors" %>
+        <span style="color:<%= cycle("red", "green", "blue", :name => "colors") -%>">
+        <%= value %>
+        </span>
+      <% end %>
+      <% reset_cycle("colors") %>
+    </td>
+  </tr>
 <% end %>
-</table>
 ```
 
 Contributing to bicycle

data/Rakefile

@@ -18,7 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/sleepingstu/bicycle"
   gem.license = "MIT"
   gem.summary = %Q{Why walk when you can cycle}
-  gem.description = %Q{A conveniance gem for cycling through a set of values, much like the 'cycle' functionality found in Rails, but is independant of which framework you use so will run in Sinatra, Padrino or straight up Ruby itself.}
+  gem.description = %Q{A convenience gem for cycling through a set of values, ported from the 'cycle' functionality found in Rails. It is independent of which framework you use so will run in Sinatra, Padrino or straight up Ruby itself.}
   gem.email = "sleepingstu@gmail.com"
   gem.authors = ["Stuart Chinery"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/bicycle.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "bicycle"
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stuart Chinery"]
   s.date = "2012-06-06"
-  s.description = "A conveniance gem for cycling through a set of values, much like the 'cycle' functionality found in Rails, but is independant of which framework you use so will run in Sinatra, Padrino or straight up Ruby itself."
+  s.description = "A convenience gem for cycling through a set of values, ported from the 'cycle' functionality found in Rails. It is independent of which framework you use so will run in Sinatra, Padrino or straight up Ruby itself."
   s.email = "sleepingstu@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -43,23 +43,17 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<turn>, ["~> 0.9.5"])
     else
       s.add_dependency(%q<minitest>, [">= 0"])
       s.add_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<turn>, ["~> 0.9.5"])
     end
   else
     s.add_dependency(%q<minitest>, [">= 0"])
     s.add_dependency(%q<yard>, ["~> 0.6.0"])
     s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<turn>, ["~> 0.9.5"])
   end
 end
 

data/lib/bicycle.rb

@@ -1,11 +1,96 @@
 module Bicycle
 
-  # Function to return a single value from an array of
-  # given values that you want to cycle through.
-  # @param [Array] *to_cycle - values to cycle through
-  # @return [?] one of the values in a given order
-  def self.cycle(*to_cycle)
-    return to_cycle[@_cycle = ((@_cycle || -1) + 1) % to_cycle.count]
+  # Creates a Cycle object whose _to_s_ method cycles through elements of an
+  # array every time it is called. This can be used for example, to alternate
+  # classes for table rows. You can use named cycles to allow nesting in loops.
+  # Passing a Hash as the last parameter with a <tt>:name</tt> key will create a
+  # named cycle. The default name for a cycle without a +:name+ key is
+  # <tt>"default"</tt>. You can manually reset a cycle by calling reset_cycle
+  # and passing the name of the cycle. The current cycle string can be obtained
+  # anytime using the current_cycle method.
+  #
+  def cycle(*values)
+    if (values.last.instance_of? Hash)
+      params = values.pop
+      name = params[:name]
+    else
+      name = "default"
+    end
+
+    cycle = get_cycle(name)
+    unless cycle && cycle.values == values
+      cycle = set_cycle(name, Cycle.new(values))
+    end
+    cycle.to_s
+  end
+
+  # Returns the current cycle string after a cycle has been started. Useful
+  # for complex table highlighting or any other design need which requires
+  # the current cycle string in more than one place.
+  #
+  def current_cycle(name = "default")
+    cycle = get_cycle(name)
+    cycle.current_value if cycle
+  end
+
+  # Resets a cycle so that it starts from the first element the next time
+  # it is called. Pass in +name+ to reset a named cycle.
+  #
+  def reset_cycle(name = "default")
+    cycle = get_cycle(name)
+    cycle.reset if cycle
+  end
+
+  class Cycle #:nodoc:
+    attr_reader :values
+
+    def initialize(values)
+      @values = values
+      reset
+    end
+
+    def reset
+      @index = 0
+    end
+
+    def current_value
+      @values[previous_index].to_s
+    end
+
+    def to_s
+      value = @values[@index].to_s
+      @index = next_index
+      return value
+    end
+
+    private
+
+    def next_index
+      step_index(1)
+    end
+
+    def previous_index
+      step_index(-1)
+    end
+
+    def step_index(n)
+      (@index + n) % @values.size
+    end
+  end
+
+  private
+
+  # The cycle helpers need to store the cycles in a place that is
+  # guaranteed to be reset every time a page is rendered, so it
+  # uses an instance variable of ActionView::Base.
+  def get_cycle(name)
+    @_cycles = Hash.new unless defined?(@_cycles)
+    return @_cycles[name]
+  end
+
+  def set_cycle(name, cycle_object)
+    @_cycles = Hash.new unless defined?(@_cycles)
+    @_cycles[name] = cycle_object
   end
 
 end

data/test/helper.rb

@@ -1,6 +1,3 @@
-require 'simplecov'
-SimpleCov.start
-
 require 'rubygems'
 require 'bundler'
 begin
@@ -12,13 +9,13 @@ rescue Bundler::BundlerError => e
 end
 
 require 'minitest/spec'
-begin; require 'turn/autorun'; rescue LoadError; end
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'bicycle'
 
 class MiniTest::Unit::TestCase
+
 end
 
 MiniTest::Unit.autorun

data/test/test_bicycle.rb

@@ -1,17 +1,107 @@
 require 'helper'
+include Bicycle
 
 describe "When cycling" do
-	before do
-		@values = []
-		for i in (0..3)
-			@values[i] = Bicycle.cycle("Foo", "Bar", "Huh?")
+	describe "with values" do
+		before do
+			@values = []
+			for i in (0..3)
+				@values[i] = cycle("Foo", "Bar", "Huh?")
+			end
+		end
+
+		it "should return a value in the cycle order" do
+			assert_equal "Foo", @values[0]
+			assert_equal "Bar", @values[1]
+			assert_equal "Huh?", @values[2]
+			assert_equal "Foo", @values[3]
+		end
+
+		describe "and with new values" do
+			before do
+				@values = []
+				for i in (0..5)
+					@values[i] = cycle("I", "just", "want", "to", "ride", :name => "bikes")
+				end
+			end
+
+			it "should return a new value in the cycle order" do
+				assert_equal "I", @values[0]
+				assert_equal "just", @values[1]
+				assert_equal "want", @values[2]
+				assert_equal "to", @values[3]
+				assert_equal "ride", @values[4]
+				assert_equal "I", @values[0]
+			end
 		end
 	end
 
-	it "should return a value in the cycle order" do
-		assert_equal "Foo", @values[0]
-		assert_equal "Bar", @values[1]
-		assert_equal "Huh?", @values[2]
-		assert_equal "Foo", @values[3]
+	describe "with multiple instances in one loop" do
+		before do
+			@values = []
+			@sub_values = []
+			for i in (0..3)
+				@values[i] = cycle("Foo", "Bar", "Huh?")
+
+				value = []
+				for j in (0..5)
+					value[j] = cycle("I", "just", "want", "to", "ride", :name => "bikes")
+				end
+				@sub_values[i] = value
+
+				reset_cycle("bikes")
+			end
+		end
+
+		it "should return a value from the first cycle order" do
+			assert_equal "Foo", @values[0]
+			assert_equal "Bar", @values[1]
+			assert_equal "Huh?", @values[2]
+			assert_equal "Foo", @values[3]
+		end
+
+		it "should return a value from the first bike cycle order" do
+			assert_equal "I", @sub_values[0][0]
+			assert_equal "just", @sub_values[0][1]
+			assert_equal "want", @sub_values[0][2]
+			assert_equal "to", @sub_values[0][3]
+			assert_equal "ride", @sub_values[0][4]
+			assert_equal "I", @sub_values[0][0]
+		end
+
+		it "should return a value from the second bike cycle order" do
+			assert_equal "I", @sub_values[1][0]
+			assert_equal "just", @sub_values[1][1]
+			assert_equal "want", @sub_values[1][2]
+			assert_equal "to", @sub_values[1][3]
+			assert_equal "ride", @sub_values[1][4]
+			assert_equal "I", @sub_values[1][0]
+		end
+
+		it "should return a value from the third bike cycle order" do
+			assert_equal "I", @sub_values[2][0]
+			assert_equal "just", @sub_values[2][1]
+			assert_equal "want", @sub_values[2][2]
+			assert_equal "to", @sub_values[2][3]
+			assert_equal "ride", @sub_values[2][4]
+			assert_equal "I", @sub_values[2][0]
+		end
+	end
+
+	describe "finding its current cycle" do
+		before do
+			@values = []
+			@current = []
+			for i in (0..5)
+				@values[i] = cycle("I", "just", "want", "to", "ride")
+				@current[i] = current_cycle
+			end
+		end
+
+		it "should match whats cycled" do
+			for i in (0..5)
+				assert_equal @values[i], @current[i]
+			end
+		end
 	end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bicycle
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Stuart Chinery
@@ -77,37 +77,7 @@ dependencies:
   version_requirements: *id004
   name: jeweler
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id005
-  name: simplecov
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 9
-        - 5
-        version: 0.9.5
-  version_requirements: *id006
-  name: turn
-  prerelease: false
-description: A conveniance gem for cycling through a set of values, much like the 'cycle' functionality found in Rails, but is independant of which framework you use so will run in Sinatra, Padrino or straight up Ruby itself.
+description: A convenience gem for cycling through a set of values, ported from the 'cycle' functionality found in Rails. It is independent of which framework you use so will run in Sinatra, Padrino or straight up Ruby itself.
 email: sleepingstu@gmail.com
 executables: []