Merge pull request #39 from maxmeyer/feature/test_suite

Jason Long · Jason Long · commit 8db55eecb6bc · 2015-01-08T13:16:53.000-05:00
Add basic test suite
diff --git a/.rspec b/.rspec
@@ -0,0 +1,3 @@
+--format Fuubar
+--order rand
+--color
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,13 @@
+AllCops:
+  Exclude:
+    - 'tmp/**/*'
+
+# Configuration parameters: MaxSlashes.
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+Metrics/AbcSize:
+  Enabled: false
+
+Lint/Debugger:
+  Enabled: false
diff --git a/Gemfile b/Gemfile
@@ -2,3 +2,23 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in geopatterns.gemspec
 gemspec
+
+group :development, :test do
+  gem 'rspec'
+  gem 'aruba'
+  gem 'rake'
+  gem 'rubocop'
+  gem 'simplecov'
+  gem 'fuubar'
+  gem 'inch'
+  gem 'activesupport'
+  gem 'pry'
+
+  if RUBY_VERSION >= "2"
+    gem 'byebug'
+    gem 'pry-byebug'
+  else
+    gem 'debugger'
+    gem 'pry-debugger'
+  end
+end
diff --git a/README.md b/README.md
@@ -28,25 +28,25 @@ Or install it yourself as:
 Make a new pattern:
 
 ```ruby
-pattern = GeoPattern.generate("Mastering Markdown")
+pattern = GeoPattern.generate('Mastering Markdown')
 ```
 
 To specify a base background color (with a hue and saturation that adjusts depending on the string):
 
 ```ruby
-pattern = GeoPattern.generate("Mastering Markdown", {:base_color => "#fc0"})
+pattern = GeoPattern.generate('Mastering Markdown', base_color: '#fc0')
 ```
 
 To use a specific background color (w/o any hue or saturation adjustments):
 
 ```ruby
-pattern = GeoPattern.generate("Mastering Markdown", {:color => "#fc0"})
+pattern = GeoPattern.generate('Mastering Markdown', color: '#fc0')
 ```
 
 To use a specific [pattern generator](#available-patterns):
 
 ```ruby
-pattern = GeoPattern.generate("Mastering Markdown", {:generator => GeoPattern::SineWavePattern})
+pattern = GeoPattern.generate('Mastering Markdown', generator: GeoPattern::SineWavePattern)
 ```
 
 Get the SVG string:
diff --git a/Rakefile b/Rakefile
@@ -1 +1,23 @@
-require "bundler/gem_tasks"
+require 'rubocop/rake_task'
+require 'inch/rake'
+require 'rspec/core/rake_task'
+
+desc 'Default task running Tests'
+task default: :test
+
+desc 'Run test suite'
+task test: 'test:rspec'
+# task test: %w(test:rspec test:rubocop)
+
+namespace :test do
+
+  RSpec::Core::RakeTask.new(:rspec)
+
+  RuboCop::RakeTask.new
+
+  Inch::Rake::Suggest.new
+end
+
+namespace :gem do
+  require 'bundler/gem_tasks'
+end
diff --git a/geo_pattern.gemspec b/geo_pattern.gemspec
@@ -4,22 +4,20 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'geo_pattern/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "geo_pattern"
+  spec.name          = 'geo_pattern'
   spec.version       = GeoPattern::VERSION
-  spec.authors       = ["Jason Long"]
-  spec.email         = ["jlong@github.com"]
+  spec.authors       = ['Jason Long']
+  spec.email         = ['jlong@github.com']
   spec.summary       = %q{Generate SVG beautiful patterns}
   spec.description   = %q{Generate SVG beautiful patterns}
-  spec.homepage      = "https://github.com/jasonlong/geo_pattern"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/jasonlong/geo_pattern'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "color", "~> 1.5"
-
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_dependency 'color', '~> 1.5'
+  spec.add_development_dependency 'bundler', '~> 1.5'
 end
diff --git a/lib/geo_pattern.rb b/lib/geo_pattern.rb
@@ -1,7 +1,30 @@
-require "geo_pattern/version"
-require "geo_pattern/svg"
-require 'geo_pattern/pattern/pattern_helpers'
-require "geo_pattern/pattern_generator"
+require 'base64'
+require 'digest/sha1'
+require 'color'
+
+require 'geo_pattern/version'
+require 'geo_pattern/svg'
+require 'geo_pattern/pattern_helpers'
+
+require 'geo_pattern/pattern/base_pattern'
+require 'geo_pattern/pattern/chevron_pattern'
+require 'geo_pattern/pattern/concentric_circles_pattern'
+require 'geo_pattern/pattern/diamond_pattern'
+require 'geo_pattern/pattern/hexagon_pattern'
+require 'geo_pattern/pattern/mosaic_squares_pattern'
+require 'geo_pattern/pattern/nested_squares_pattern'
+require 'geo_pattern/pattern/octagon_pattern'
+require 'geo_pattern/pattern/overlapping_circles_pattern'
+require 'geo_pattern/pattern/overlapping_rings_pattern'
+require 'geo_pattern/pattern/plaid_pattern'
+require 'geo_pattern/pattern/plus_sign_pattern'
+require 'geo_pattern/pattern/sine_wave_pattern'
+require 'geo_pattern/pattern/square_pattern'
+require 'geo_pattern/pattern/tessellation_pattern'
+require 'geo_pattern/pattern/triangle_pattern'
+require 'geo_pattern/pattern/xes_pattern'
+
+require 'geo_pattern/pattern_generator'
 
 module GeoPattern
   def self.generate(string=Time.now, opts={})
diff --git a/lib/geo_pattern/pattern_generator.rb b/lib/geo_pattern/pattern_generator.rb
@@ -1,7 +1,3 @@
-require 'base64'
-require 'digest/sha1'
-require 'color'
-
 module GeoPattern
   class PatternGenerator
     DEFAULTS = {
diff --git a/lib/geo_pattern/pattern_helpers.rb b/lib/geo_pattern/pattern_helpers.rb
@@ -1,5 +1,3 @@
-Dir[File.join(File.dirname(__FILE__), '**', '*.rb')].each { |file| require file }
-
 module GeoPattern
   module PatternHelpers
     def self.hex_val(hash, index, length)
diff --git a/lib/geo_pattern/svg.rb b/lib/geo_pattern/svg.rb
@@ -1,5 +1,7 @@
 module GeoPattern
   class SVG
+    include Comparable
+
     def initialize
       @width      = 100
       @height     = 100
@@ -67,5 +69,9 @@ def write_args(args)
     def self.as_comment(str)
       "<!-- #{str} -->"
     end
+
+    def <=>(other)
+      to_s <=> other.to_s
+    end
   end
 end
diff --git a/spec/geo_pattern_spec.rb b/spec/geo_pattern_spec.rb
@@ -0,0 +1,44 @@
+# encoding: utf-8
+require 'spec_helper'
+
+RSpec.describe GeoPattern do
+  let(:string) { 'Mastering Markdown' }
+
+  context '.generate' do
+    it 'generates a pattern for a string' do
+      pattern = GeoPattern.generate(string)
+      expect(pattern).not_to be_nil
+    end
+
+    it 'is always the same' do
+      pattern1 = GeoPattern.generate(string)
+      pattern2 = GeoPattern.generate(string)
+
+      expect(pattern1.svg_string).to eq pattern2.svg_string
+    end
+
+    it 'sets background color with adjusting hue and saturation based on string' do
+      html_base_color = '#fc0'
+      rgb_base_color  = html_to_rgb_for_string(string, html_base_color)
+      pattern         = GeoPattern.generate(string, base_color: html_base_color)
+
+      expect(pattern.svg_string).to include(rgb_base_color)
+    end
+
+    it 'sets background color' do
+      html_base_color = '#fc0'
+      rgb_base_color  = html_to_rgb(html_base_color)
+      pattern         = GeoPattern.generate(string, color: html_base_color)
+
+      expect(pattern.svg_string).to include(rgb_base_color)
+    end
+
+    it 'uses the specified generator' do
+
+      pattern1 = GeoPattern.generate(string, generator: GeoPattern::SineWavePattern)
+      pattern2  = GeoPattern.generate(string)
+
+      expect(pattern1.svg_string).not_to eq pattern2.svg_string
+    end
+  end
+end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -0,0 +1,19 @@
+# encoding: utf-8
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require 'simplecov'
+SimpleCov.command_name 'rspec'
+SimpleCov.start
+
+# Pull in all of the gems including those in the `test` group
+require 'bundler'
+Bundler.require :default, :test, :development
+
+require 'geo_pattern'
+
+# Loading support files
+Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
+Dir.glob(::File.expand_path('../shared_examples/*.rb', __FILE__)).each { |f| require_relative f }
+
+# No need to add the namespace to every class tested
+include GeoPattern
diff --git a/spec/support/aruba.rb b/spec/support/aruba.rb
@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'aruba/api'
+require 'aruba/reporting'
+
+# Spec Helpers
+module SpecHelper
+  # Helpers for aruba
+  module Aruba
+    include ::Aruba::Api
+
+    def dirs
+      @dirs ||= %w(tmp rspec)
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include SpecHelper::Aruba
+
+  c.before :each do
+    clean_current_dir
+    restore_env
+  end
+end
diff --git a/spec/support/helpers.rb b/spec/support/helpers.rb
@@ -0,0 +1,34 @@
+module SpecHelpers
+  def html_to_rgb(color)
+    generate_rgb_string(Color::RGB.from_html(color))
+  end
+
+  def html_to_rgb_for_string(string, base_color)
+    hash = Digest::SHA1.hexdigest string
+
+    hue_offset     = GeoPattern::PatternHelpers.map(GeoPattern::PatternHelpers.hex_val(hash, 14, 3), 0, 4095, 0, 359)
+    sat_offset     = GeoPattern::PatternHelpers.hex_val(hash, 17, 1)
+    base_color     = Color::RGB.from_html(base_color).to_hsl
+    base_color.hue = base_color.hue - hue_offset;
+
+    if (sat_offset % 2 == 0)
+      base_color.saturation = base_color.saturation + sat_offset
+    else
+      base_color.saturation = base_color.saturation - sat_offset
+    end
+
+    generate_rgb_string(base_color.to_rgb)
+  end
+
+  def generate_rgb_string(rgb)
+    r = (rgb.r * 255).round
+    g = (rgb.g * 255).round
+    b = (rgb.b * 255).round
+
+    format("rgb(%d, %d, %d)", r, g, b)
+  end
+end
+
+RSpec.configure do |config|
+  config.include SpecHelpers
+end
diff --git a/spec/support/rspec.rb b/spec/support/rspec.rb
@@ -0,0 +1,24 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+  config.warnings = false
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+  Kernel.srand config.seed
+end
diff --git a/spec/support/string.rb b/spec/support/string.rb
@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'active_support/core_ext/string/strip'
diff --git a/spec/svg_spec.rb b/spec/svg_spec.rb
@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+RSpec.describe SVG do
+  context '#<=>' do
+    it 'is comparable' do
+      svg1 = SVG.new
+      svg2 = SVG.new
+
+      expect(svg1).to eq svg2
+    end
+  end
+end

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+--format Fuubar`
	`2`	`+--order rand`
	`3`	`+--color`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-Dir[File.join(File.dirname(__FILE__), '*', '.rb')].each { \|file\| require file }`
`2`		`-`
`3`	`1`	`module GeoPattern`
`4`	`2`	`module PatternHelpers`
`5`	`3`	`def self.hex_val(hash, index, length)`