geo_pattern 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81c3c62556904d41859cbdc5f24b309d27643d61
-  data.tar.gz: 13208f9b302c0294458d5c6d33ed41c5ea6bddf2
+  metadata.gz: 505b039dc31f17e65a619928b123b061077629ad
+  data.tar.gz: 549237f81df720c5ef2a9a2767b4d7be0ee3a96f
 SHA512:
-  metadata.gz: 429e50e9f25823d253761aae3b9fedf5a113271bd1cbeb495a32b4f7d828af56a7c9a8308553e85e50f93266d3e2c19f90fb93a72504c096d029aec6c962f3d2
-  data.tar.gz: 77b6992af30dba44823e148850fa32e7de5b0b04454c091818d4ce99714a8bb4e07b89f148d47ae06903389472063b23e0b94b455e6cca194991c6a44dbc3eb9
+  metadata.gz: 982753d4976ffe9aeef807a814aecc5e4a8a64f972228a05eef69dde285c4ec42d9b8dd328f5b0fbd5dbe6218fdad26a6956b729f443b21cb9fa54ea8628a3bc
+  data.tar.gz: 185373a809c450c8427928f72e0c4d4941b1c3182d78ddac129f797a5e67477ab66bfcd232c03358ee996e0c98efd1e578402de00d570dca58f0c968829ed6c4

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - 'tmp/**/*'
+  DisplayCopNames: true
 
 # Configuration parameters: MaxSlashes.
 Style/RegexpLiteral:
@@ -11,3 +12,60 @@ Metrics/AbcSize:
 
 Lint/Debugger:
   Enabled: false
+
+# Offense count: 1
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Enabled: false
+
+# Offense count: 2
+Lint/Eval:
+  Enabled: false
+
+# Offense count: 6
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 8
+Metrics/CyclomaticComplexity:
+  Max: 22
+
+# Offense count: 155
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 406
+
+# Offense count: 24
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 78
+
+# Offense count: 6
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Offense count: 2
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 36
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+Style/EmptyElse:
+  Enabled: false
+
+# Offense count: 10
+Style/EvenOdd:
+  Enabled: false
+
+# Offense count: 28
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/For:
+  Enabled: false
+
+# Offense count: 3
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+class ExcludeRegexFilter < SimpleCov::Filter
+  def matches?(source_file)
+    source_file.filename !~ filter_argument
+  end
+end
+
+class IncludeRegexFilter < SimpleCov::Filter
+  def matches?(source_file)
+    source_file.filename =~ filter_argument
+  end
+end
+
+SimpleCov.start do
+  add_filter "/features/"
+  add_filter "/fixtures/"
+  add_filter "/spec/"
+  add_filter "/tmp"
+  add_filter "/vendor"
+
+  generator_filter = %r{/background_generators/|/structure_generators/}
+  add_group "lib", ExcludeRegexFilter.new(generator_filter)
+  add_group "generators", IncludeRegexFilter.new(generator_filter)
+end

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+env:
+  - CI=1
+language: ruby
+bundler_args: --without debug
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+install: script/bootstrap
+script: script/test
+cache: bundler

data/Gemfile

@@ -13,8 +13,10 @@ group :development, :test do
   gem 'inch'
   gem 'activesupport'
   gem 'pry'
+  gem 'pry-rescue'
+  gem 'pry-stack_explorer'
 
-  if RUBY_VERSION >= "2"
+  if RUBY_VERSION >= '2'
     gem 'byebug'
     gem 'pry-byebug'
   else

data/README.md

@@ -1,13 +1,24 @@
 [![](http://img.shields.io/gem/v/geo_pattern.svg?style=flat)](http://rubygems.org/gems/geo_pattern)
+[![](https://img.shields.io/travis/jasonlong/geo_pattern.svg?style=flat)](https://travis-ci.org/jasonlong/geo_pattern)
 [![](http://img.shields.io/gem/dt/geo_pattern.svg?style=flat)](http://rubygems.org/gems/geo_pattern)
 
 # GeoPattern
 
-Generate beautiful tiling SVG patterns from a string. The string is converted into a SHA and a color and pattern are determined based on the values in the hash. The color is determined by shifting the hue and saturation from a default (or passed in) base color. One of 16 patterns is used (or you can specify one) and the sizing of the pattern elements is also determined by the hash values.
+Generate beautiful tiling SVG patterns from a string. The string is converted
+into a SHA and a color and pattern are determined based on the values in the
+hash. The color is determined by shifting the hue and saturation from a default
+(or passed in) base color. One of 16 patterns is used (or you can specify one)
+and the sizing of the pattern elements is also determined by the hash values.
 
-You can use the generated pattern as the `background-image` for a container. Using the `base64` representation of the pattern still results in SVG rendering, so it looks great on retina displays.
+You can use the generated pattern as the `background-image` for a container.
+Using the `base64` representation of the pattern still results in SVG
+rendering, so it looks great on retina displays.
 
-See the [GitHub Guides](http://guides.github.com) site and the [Explore section of GitHub](https://github.com/explore) are examples of this library in action. Brandon Mills has put together an awesome [live preview page](http://btmills.github.io/geopattern/geopattern.html) that's built on his Javascript port.
+See the [GitHub Guides](http://guides.github.com) site and the [Explore section
+of GitHub](https://github.com/explore) are examples of this library in action.
+Brandon Mills has put together an awesome [live preview
+page](http://btmills.github.io/geopattern/geopattern.html) that's built on his
+Javascript port.
 
 ## Installation
 
@@ -46,93 +57,175 @@ 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', patterns: :sine_waves)
+```
+
+To use a subset of the [available patterns](#available-patterns):
+
+```ruby
+pattern = GeoPattern.generate('Mastering Markdown', patterns: [:sine_waves, :xes])
 ```
 
 Get the SVG string:
 
 ```ruby
-puts pattern.svg_string
+puts pattern.to_svg
 # => <svg xmlns="http://www.w3.org/2000/svg" ...
 ```
 
 Get the Base64 encoded string:
 
 ```ruby
-puts pattern.base64_string
+puts pattern.to_base64
 # => PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC...
 ```
 
 You can then use this string to set the background:
 
 ```html
-<div style="background-image: <%= pattern.uri_image %>"></div>
+<div style="background-image: <%= pattern.to_data_uri %>"></div>
 ```
 
 ## Available patterns
 
-*Note: As of version `1.3.0`, string references (e.g. `overlapping_circles`) are deprecated in favor of class references (e.g. `GeoPattern::OverlappingCirclesPattern`).*
+*Note: As of version `1.3.0`, string references (e.g. `overlapping_circles`)
+are deprecated in favor of symbol references (e.g. `:overlapping_circles`).*
+
+### :chevrons
+
+![](http://jasonlong.github.io/geo_pattern/examples/chevrons.png)
 
-### GeoPattern::OctagonPattern
+
+### :octagons
 
 ![](http://jasonlong.github.io/geo_pattern/examples/octogons.png)
 
-### GeoPattern::OverlappingCirclesPattern
+### :overlapping_circles
 
 ![](http://jasonlong.github.io/geo_pattern/examples/overlapping_circles.png)
 
-### GeoPattern::PlusSignPattern
+### :plus_signs
 
 ![](http://jasonlong.github.io/geo_pattern/examples/plus_signs.png)
 
-### GeoPattern::XesPattern
+### :xes
 
 ![](http://jasonlong.github.io/geo_pattern/examples/xes.png)
 
-### GeoPattern::SineWavePattern
+### :sine_waves
 
 ![](http://jasonlong.github.io/geo_pattern/examples/sine_waves.png)
 
-### GeoPattern::HexagonPattern
+### :hexagons
 
 ![](http://jasonlong.github.io/geo_pattern/examples/hexagons.png)
 
-### GeoPattern::OverlappingCirclesPattern
+### :overlapping_rings
 
 ![](http://jasonlong.github.io/geo_pattern/examples/overlapping_rings.png)
 
-### GeoPattern::PlaidPattern
+### :plaid
 
 ![](http://jasonlong.github.io/geo_pattern/examples/plaid.png)
 
-### GeoPattern::TrianglePattern
+### :triangles
 
 ![](http://jasonlong.github.io/geo_pattern/examples/triangles.png)
 
-### GeoPattern::SquarePattern
+### :squares
 
 ![](http://jasonlong.github.io/geo_pattern/examples/squares.png)
 
-### GeoPattern::NestedSquaresPattern
+### :nested_squares
 
 ![](http://jasonlong.github.io/geo_pattern/examples/nested_squares.png)
 
-### GeoPattern::MosaicSquaresPattern
+### :mosaic_squares
 
 ![](http://jasonlong.github.io/geo_pattern/examples/mosaic_squares.png)
 
-### GeoPattern::ConcentricCirclesPattern
+### :concentric_circles
 
 ![](http://jasonlong.github.io/geo_pattern/examples/concentric_circles.png)
 
-### GeoPattern::DiamondPattern
+### :diamonds
 
 ![](http://jasonlong.github.io/geo_pattern/examples/diamonds.png)
 
-### GeoPattern::TessellationPattern
+### :tessellation
 
 ![](http://jasonlong.github.io/geo_pattern/examples/tessellation.png)
 
+### GeoPattern::ChevronPattern
+
+![](http://jasonlong.github.io/geo_pattern/examples/chevrons.png)
+
+
+## Inspection of pattern
+
+If you want to get some more information about a pattern, please use the
+following methods.
+
+```ruby
+pattern = GeoPattern.generate('Mastering Markdown', patterns: [:sine_waves, :xes])
+
+# The color of the background in html notation
+pattern.background.color.to_html
+
+# The color of the background in svg notation
+pattern.background.color.to_svg
+
+
+# The input colors
+pattern.background.preset.color
+pattern.background.preset.base_color
+
+# The generator
+pattern.background.generator
+```
+
+To get more information about the structure of the pattern, please use the following methods:
+
+```ruby
+pattern = GeoPattern.generate('Mastering Markdown', patterns: [:sine_waves, :xes])
+
+# The name of the structure
+pattern.structure.name
+
+# The generator of the structure
+pattern.structure.generator
+```
+
+## Rake Support
+
+```ruby
+string = 'Mastering markdown'
+
+require 'geo_pattern/geo_pattern_task'
+
+GeoPattern::GeoPatternTask.new(
+  name: 'generate',
+  description: 'Generate patterns to make them available as fixtures',
+  data: {
+    'fixtures/generated_patterns/diamonds_with_color.svg'      => { input: string, patterns: [:diamonds], color: '#00ff00' },
+    'fixtures/generated_patterns/diamonds_with_base_color.svg' => { input: string, patterns: [:diamonds], base_color: '#00ff00' }
+  }
+)
+```
+
+## Developing
+
+### Generate Fixtures
+
+```ruby
+rake fixtures:generate
+```
+
+### Run tests
+
+```ruby
+rake test
+```
 
 ## Contributing
 
@@ -142,6 +235,15 @@ You can then use this string to set the background:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Development
+
+Prefix rspec-commandline with `RSPEC_PROFILE=1` to output the ten slowest
+examples of the test suite.
+
+```bash
+RSPEC_PROFILE=1 bundle exec rspec
+```
+
 ## Ports
 
 JavaScript port by Brandon Mills:

data/Rakefile

@@ -1,23 +1,86 @@
-require 'rubocop/rake_task'
-require 'inch/rake'
-require 'rspec/core/rake_task'
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 
 desc 'Default task running Tests'
 task default: :test
 
 desc 'Run test suite'
-task test: 'test:rspec'
-# task test: %w(test:rspec test:rubocop)
-
+task test: ['test:rubocop', 'test:rspec']
+task 'test:ci' => ['bootstrap:gem_requirements', :test]
 namespace :test do
+  task :rspec do
+    sh 'rspec'
+  end
 
-  RSpec::Core::RakeTask.new(:rspec)
+  task :rubocop do
+    sh 'rubocop'
+  end
 
-  RuboCop::RakeTask.new
+  task 'rubocop:autocorrect' do
+    sh 'rubocop --auto-correct'
+  end
 
-  Inch::Rake::Suggest.new
+  task 'inch' do
+    sh 'inch'
+  end
 end
 
 namespace :gem do
   require 'bundler/gem_tasks'
 end
+
+unless ENV.key?('CI')
+  require 'geo_pattern/geo_pattern_task'
+
+  namespace :fixtures do
+    string = 'Mastering Markdown'
+
+    GeoPattern::GeoPatternTask.new(
+      name: 'generate',
+      description: 'Generate patterns to make them available as fixtures',
+      data: {
+        'fixtures/generated_patterns/chevrons.svg'                 => { input: string, patterns: [:chevrons] },
+        'fixtures/generated_patterns/concentric_circles.svg'       => { input: string, patterns: [:concentric_circles] },
+        'fixtures/generated_patterns/diamonds.svg'                 => { input: string, patterns: [:diamonds] },
+        'fixtures/generated_patterns/hexagons.svg'                 => { input: string, patterns: [:hexagons] },
+        'fixtures/generated_patterns/mosaic_squares.svg'           => { input: string, patterns: [:mosaic_squares] },
+        'fixtures/generated_patterns/nested_squares.svg'           => { input: string, patterns: [:nested_squares] },
+        'fixtures/generated_patterns/octagons.svg'                 => { input: string, patterns: [:octagons] },
+        'fixtures/generated_patterns/overlapping_circles.svg'      => { input: string, patterns: [:overlapping_circles] },
+        'fixtures/generated_patterns/overlapping_rings.svg'        => { input: string, patterns: [:overlapping_rings] },
+        'fixtures/generated_patterns/plaid.svg'                    => { input: string, patterns: [:plaid] },
+        'fixtures/generated_patterns/plus_signs.svg'               => { input: string, patterns: [:plus_signs] },
+        'fixtures/generated_patterns/sine_waves.svg'               => { input: string, patterns: [:sine_waves] },
+        'fixtures/generated_patterns/squares.svg'                  => { input: string, patterns: [:squares] },
+        'fixtures/generated_patterns/tessellation.svg'             => { input: string, patterns: [:tessellation] },
+        'fixtures/generated_patterns/triangles.svg'                => { input: string, patterns: [:triangles] },
+        'fixtures/generated_patterns/xes.svg'                      => { input: string, patterns: [:xes] },
+        'fixtures/generated_patterns/diamonds_with_color.svg'      => { input: string, patterns: [:diamonds], color: '#00ff00' },
+        'fixtures/generated_patterns/diamonds_with_base_color.svg' => { input: string, patterns: [:diamonds], base_color: '#00ff00' }
+      }
+    )
+  end
+end
+
+desc 'Bootstrap project'
+task bootstrap: %w(bootstrap:bundler)
+
+desc 'Bootstrap project for ci'
+task 'bootstrap:ci' do
+  Rake::Task['bootstrap'].invoke
+end
+
+namespace :bootstrap do
+  desc 'Bootstrap bundler'
+  task :bundler do |t|
+    puts t.comment
+    sh 'gem install bundler'
+    sh 'bundle install'
+  end
+
+  desc 'Require gems'
+  task :gem_requirements do |t|
+    puts t.comment
+    require 'bundler'
+    Bundler.require
+  end
+end