funding_primer 0.1.2 → 0.2.0

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    funding_primer (0.1.1)
+    funding_primer (0.1.2)
       gem-man (~> 0.3.0)
       methadone (~> 1.2.2)
+      rainbow (~> 1.1.4)
       terminal-table (~> 1.4.5)
 
 GEM
@@ -29,6 +30,7 @@ GEM
     json (1.7.5)
     methadone (1.2.2)
       bundler
+    rainbow (1.1.4)
     rake (0.9.5)
     rdoc (3.12)
       json (~> 1.4)

data/Rakefile

@@ -56,10 +56,9 @@ Cucumber::Rake::Task.new(:features) do |t|
 end
 
 Rake::RDocTask.new do |rd|
-  
   rd.main = "README.rdoc"
-  
   rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'funding_primer - Multiplication tables for prime numbers!'
 end
 
 task :default => [:spec,:features]

data/bin/funding_primer

@@ -10,13 +10,26 @@ class App
   include Methadone::CLILogging
 
   main do |number_of_primes=10|
+    # by default, use colour when outputting to terminals,
+    # and plain text otherwise
+    if options[:color].nil?
+      if STDOUT.tty?
+        options[:color] = true
+      else
+        options[:color] = false
+      end
+    end
+
     matrix = MultiplicationTable.new(1..Integer(number_of_primes)).with_headings
+
+    if options[:color]
+      matrix = ColorMatrix.new(matrix)
+    end
+
     formatter = Format::Table.new(matrix)
     formatter.print
   end
 
-  # supplemental methods here
-
   # Declare command-line interface here
 
   description "Multiplication tables for prime numbers!"
@@ -26,7 +39,7 @@ class App
   # options[flag] will contain VAL
   #
   # Specify switches via:
-  # on("--[no-]switch","Some switch")
+  on("--[no-]color","Colourful output")
   #
   # Or, just call OptionParser methods on opts
   #
@@ -37,5 +50,8 @@ class App
 
   use_log_level_option
 
+  # defaults_from_config_file
+  # defaults_from_env_var
+
   go!
 end

data/features/colour_output.feature.disabled

@@ -0,0 +1,12 @@
+# unfortunately, cucumber seems to strip colour directives from output,
+# so this particular feature gives a false failure
+Feature: Output a pretty table with highlighted headings
+  In order to see clearly what the table represents
+  As a prime number enthusiast curious about composites
+  I want to print a colour table
+
+  Scenario: Print colour table
+    When I run `funding_primer 3 --color`
+    Then the output should contain "|   | #{'1'.bright.color :green} | #{'2'.bright.color :green} | #{'3'.bright.color :green} |"
+    And  the output should contain "| #{'1'.bright.color :green} | #{'1'.color :yellow} | 2 | 3 |"
+    

data/features/help.feature

@@ -7,10 +7,11 @@ Feature: Funding Primer gives some basic help
     When I get help for "funding_primer"
     Then the exit status should be 0
     And the banner should be present
+    And there should be a one line summary of what the app does
     And the banner should include the version
     And the banner should document that this app takes options
+    And the following options should be documented:
+      |version|
+      |color  |
     And the banner should document that this app's arguments are:
       |number_of_primes|optional|
-    And there should be a one line summary of what the app does
-    And the following options should be documented:
-      |--version|

data/funding_primer.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency('methadone', '~> 1.2.2')
   gem.add_dependency('terminal-table', '~> 1.4.5')
   gem.add_dependency('gem-man', '~> 0.3.0')
+  gem.add_dependency('rainbow', '~> 1.1.4')
 end

data/lib/funding_primer.rb

@@ -1,3 +1,4 @@
 require "funding_primer/version"
 require 'funding_primer/format'
 require 'funding_primer/multiplication_table'
+require 'funding_primer/color_matrix'

data/lib/funding_primer/color_matrix.rb

@@ -0,0 +1,33 @@
+require 'rainbow'
+require 'forwardable'
+
+module FundingPrimer
+  class ColorMatrix
+    def initialize(matrix)
+      @matrix = matrix
+      colorize
+    end
+    
+    # delegate array access to internal @matrix
+    extend Forwardable
+    def_delegators :@matrix, :[], :last
+
+  private
+    def colorize
+      # iterate over all rows and 
+      @matrix.length.times do |row|
+        @matrix.length.times do |column|
+          # paint top row
+          @matrix[row][column] = @matrix[row][column].to_s.bright.color :cyan if row == 0 and column > 0
+
+          # paint left column
+          @matrix[row][column] = @matrix[row][column].to_s.bright.color :cyan if row > 0 and column == 0
+
+          # paint diagonal
+          @matrix[row][column] = @matrix[row][column].to_s.color :green if row > 0 and row == column
+        end
+      end
+    end
+  end
+end
+

data/lib/funding_primer/version.rb

@@ -1,3 +1,3 @@
 module FundingPrimer
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/color_matrix_spec.rb

@@ -0,0 +1,35 @@
+require 'funding_primer/color_matrix'
+
+describe FundingPrimer::ColorMatrix do
+  subject do
+    matrix = [[nil,1,2,3],
+              [1,  1,2,3],
+              [2,  2,4,6],
+              [3,  3,6,9]]
+    FundingPrimer::ColorMatrix.new matrix
+  end
+
+  it 'highlights the rows and columns' do
+    subject[0][1].should eql '1'.bright.color(:cyan)
+  end
+
+  it 'highlights the diagonal' do
+    subject[3][3].should eql '9'.color(:green)
+  end
+
+  it 'highlights the rows, columns and diagonal' do
+    result = [[nil,'1'.bright.color(:cyan),'2'.bright.color(:cyan),'3'.bright.color(:cyan)],
+              ['1'.bright.color(:cyan),'1'.color(:green),2,3],
+              ['2'.bright.color(:cyan),2,'4'.color(:green),6],
+              ['3'.bright.color(:cyan),3,6,'9'.color(:green)]]
+
+    # have to loop over each element, as subject isn't actually an array
+    # it simply delegates to an internal array
+    result.length.times do |row|
+      result.length.times do |column|
+        subject[row][column].should eql result[row][column]
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: funding_primer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -123,6 +123,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.4
 description: In order to visualise the products of two prime numbers, funding_primer
   will print out a table of prime products.
 email:
@@ -143,12 +159,14 @@ files:
 - Rakefile
 - bin/funding_primer
 - features/basic_table.feature
+- features/colour_output.feature.disabled
 - features/help.feature
 - features/set_the_size.feature
 - features/step_definitions/funding_primer_steps.rb
 - features/support/env.rb
 - funding_primer.gemspec
 - lib/funding_primer.rb
+- lib/funding_primer/color_matrix.rb
 - lib/funding_primer/format.rb
 - lib/funding_primer/format/table.rb
 - lib/funding_primer/multiplication_table.rb
@@ -157,6 +175,7 @@ files:
 - man/funding_primer.1
 - man/funding_primer.1.html
 - man/funding_primer.1.ronn
+- spec/color_matrix_spec.rb
 - spec/format/table_spec.rb
 - spec/multiplication_table_spec.rb
 - spec/prime_spec.rb
@@ -186,10 +205,12 @@ specification_version: 3
 summary: Multiplication tables for prime numbers!
 test_files:
 - features/basic_table.feature
+- features/colour_output.feature.disabled
 - features/help.feature
 - features/set_the_size.feature
 - features/step_definitions/funding_primer_steps.rb
 - features/support/env.rb
+- spec/color_matrix_spec.rb
 - spec/format/table_spec.rb
 - spec/multiplication_table_spec.rb
 - spec/prime_spec.rb