geo_pattern 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 505b039dc31f17e65a619928b123b061077629ad
-  data.tar.gz: 549237f81df720c5ef2a9a2767b4d7be0ee3a96f
+SHA256:
+  metadata.gz: 30789aa4eac2677abe68600971518bbb7156096cbe03a96621668510fcf4c98d
+  data.tar.gz: c9f14ba660f3b899f5087f393afd8092d4e9396db858f6be7d62f3d90d3bf5f0
 SHA512:
-  metadata.gz: 982753d4976ffe9aeef807a814aecc5e4a8a64f972228a05eef69dde285c4ec42d9b8dd328f5b0fbd5dbe6218fdad26a6956b729f443b21cb9fa54ea8628a3bc
-  data.tar.gz: 185373a809c450c8427928f72e0c4d4941b1c3182d78ddac129f797a5e67477ab66bfcd232c03358ee996e0c98efd1e578402de00d570dca58f0c968829ed6c4
+  metadata.gz: 15da01911979383ba80390581cf9d20e36221c3dca557487727bf4d276cc3c3f789bc3be9664880eb01af283998cdf888eb93270df1af666e24301f833d94519
+  data.tar.gz: cbd53e9a6fabaa3e567d8cb5e966030196a1d57fe0393f25be55612f9189e016e173b0e9a7e2ea12d0d3fc030f7077d4006b49ab2412309d897dd93a77fab121

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## 1.6.0
+
+- Support color 2.x, whose color objects are immutable, while retaining support
+  for color 1.x and the existing SVG fixtures.
+- Declare the base64, logger, and rake runtime dependencies so the gem and its Rake
+  integration work under Bundler on modern Ruby versions.
+- Test Ruby 3.3, 3.4, 4.0, and Ruby head against color 1.x and 2.x in CI.
+- Verify the built gem in CI with only its runtime dependencies installed.
+- Publish version tags through GitHub Actions using RubyGems trusted publishing,
+  after the test and package checks pass.
+- Remove unused ActiveSupport, documentation, and debugger dependencies from
+  the development bundle.
+- Update coverage configuration for SimpleCov 1.3. Development tools require
+  Ruby 3.3 or newer.
+- Package the library, README, license, and changelog without requiring Git.
+
+The minimum Ruby version remains 2.6.
+
+## 1.5.0 — 2023-04-05
+
+- Fix Ruby 3 compatibility.
+- Require Ruby 2.6 or newer.

data/README.md

@@ -1,6 +1,13 @@
-[![](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)
+### This project is largely unmaintained now.
+
+#### I'll happily accept PRs to keep things in working order, but I no longer plan to make updates.
+
+----
+
+[![](https://img.shields.io/gem/v/geo_pattern.svg?style=flat)](http://rubygems.org/gems/geo_pattern)
+![Ruby](https://github.com/jasonlong/geo_pattern/workflows/Ruby/badge.svg)
+[![](https://img.shields.io/gem/dt/geo_pattern.svg?style=flat)](http://rubygems.org/gems/geo_pattern)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 # GeoPattern
 
@@ -14,7 +21,7 @@ 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
+See the [GitHub Guides](https://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
@@ -22,6 +29,8 @@ Javascript port.
 
 ## Installation
 
+Ruby 2.6 or greater is required. GeoPattern supports both color 1.x and 2.x.
+
 Add this line to your application's Gemfile:
 
     gem 'geo_pattern'
@@ -156,10 +165,6 @@ are deprecated in favor of symbol references (e.g. `:overlapping_circles`).*
 
 ![](http://jasonlong.github.io/geo_pattern/examples/tessellation.png)
 
-### GeoPattern::ChevronPattern
-
-![](http://jasonlong.github.io/geo_pattern/examples/chevrons.png)
-
 
 ## Inspection of pattern
 
@@ -215,21 +220,59 @@ GeoPattern::GeoPatternTask.new(
 
 ## Developing
 
+Use Ruby 3.3 or newer for development and install dependencies with `bundle install`.
+
 ### Generate Fixtures
 
-```ruby
-rake fixtures:generate
+```sh
+bundle exec rake fixtures:generate
 ```
 
 ### Run tests
 
-```ruby
-rake test
+```sh
+bundle exec rake test
 ```
 
+### Releasing
+
+See [CHANGELOG.md](CHANGELOG.md) for release notes. To prepare a release, update
+`lib/geo_pattern/version.rb` and the changelog, then run:
+
+```sh
+bundle install
+bundle exec rake test
+bundle exec rake gem:build
+```
+
+Releases are published by [the release workflow](.github/workflows/release.yml)
+when a version tag is pushed. The workflow runs the test and package checks,
+verifies that the tag matches the gem version, and publishes to RubyGems.org.
+
+Before the first automated release, a gem owner must configure
+[RubyGems trusted publishing](https://guides.rubygems.org/trusted-publishing/)
+for `geo_pattern` with these values:
+
+- Repository owner: `jasonlong`
+- Repository name: `geo_pattern`
+- Workflow filename: `release.yml`
+- Environment: `release`
+
+Create the matching `release` environment in the repository's GitHub settings.
+The workflow uses short-lived credentials; no RubyGems API key secret is needed.
+
+Commit and push the release changes, then tag that commit and push the tag:
+
+```sh
+git tag v1.6.0
+git push origin v1.6.0
+```
+
+Use the version from `lib/geo_pattern/version.rb` for subsequent releases.
+
 ## Contributing
 
-1. Fork it ( http://github.com/jasonlong/geo_pattern/fork )
+1. Fork it ( https://github.com/jasonlong/geo_pattern/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
@@ -244,19 +287,40 @@ examples of the test suite.
 RSPEC_PROFILE=1 bundle exec rspec
 ```
 
-## Ports
+## Ports & related projects
 
 JavaScript port by Brandon Mills:
-https://github.com/btmills/geopatterns-js
+https://github.com/btmills/geopattern
+
+TypeScript port by MooYeol Lee:
+https://github.com/mooyoul/geo-pattern
 
 Python port by Bryan Veloso:
 https://github.com/bryanveloso/geopatterns
 
+Elixir port by Anne Johnson:
+https://github.com/annejohnson/geo_pattern
+
 PHP port by Anand Capur:
 https://github.com/redeyeventures/geopattern-php
 
 Go port by Pravendra Singh:
-https://github.com/pravj/geo_pattern
+https://github.com/pravj/geopattern
 
 CoffeeScript port by Aleks (muchweb):
 https://github.com/muchweb/geo-pattern-coffee
+
+Cocoa port by Matt Faluotico:
+https://github.com/mattfxyz/GeoPattern-Cocoa
+
+Middleman extension by @maxmeyer:
+https://github.com/fedux-org/middleman-geo_pattern
+
+Dart(Flutter) port by @suyash:
+https://github.com/suyash/geopattern
+
+Lua port by Ivan Azoyan:
+https://github.com/azoyan/geopattern
+
+Java port by Jason Selzer:
+https://github.com/jselzer/geopattern

data/lib/geo_pattern/background.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoPattern
   class Background
     include Roles::ComparableMetadata
@@ -9,15 +11,15 @@ module GeoPattern
     def_delegators :@preset, :base_color
 
     def initialize(options)
-      @image     = options[:image]
-      @preset    = options[:preset]
-      @color     = options[:color]
+      @image = options[:image]
+      @preset = options[:preset]
+      @color = options[:color]
       @generator = options[:generator]
 
-      fail ArgumentError, 'Argument color is missing' if @color.nil?
-      fail ArgumentError, 'Argument image is missing' if @image.nil?
-      fail ArgumentError, 'Argument preset is missing' if @preset.nil?
-      fail ArgumentError, 'Argument generator is missing' if @generator.nil?
+      raise ArgumentError, "Argument color is missing" if @color.nil?
+      raise ArgumentError, "Argument image is missing" if @image.nil?
+      raise ArgumentError, "Argument preset is missing" if @preset.nil?
+      raise ArgumentError, "Argument generator is missing" if @generator.nil?
     end
 
     def_comparators :base_color, :color

data/lib/geo_pattern/background_generators/solid_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoPattern
   # Generating backgrounds
   module BackgroundGenerators
@@ -19,7 +21,7 @@ module GeoPattern
       # @param [ColorPreset] preset
       #   A preset of values which are used during generating the background
       def initialize(seed, preset)
-        @color  = color_for(seed, preset)
+        @color = color_for(seed, preset)
         @preset = preset
       end
 
@@ -37,7 +39,7 @@ module GeoPattern
 
       def generate_background
         svg = SvgImage.new
-        svg.rect(0, 0, '100%', '100%', 'fill' => color.to_svg)
+        svg.rect(0, 0, "100%", "100%", "fill" => color.to_svg)
 
         svg
       end

data/lib/geo_pattern/color.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoPattern
   class Color
     private
@@ -15,7 +17,7 @@ module GeoPattern
       g = (color.g * 255).round
       b = (color.b * 255).round
 
-      format('rgb(%d, %d, %d)', r, g, b)
+      format("rgb(%<r>d, %<g>d, %<b>d)", r: r, g: g, b: b)
     end
 
     def to_html

data/lib/geo_pattern/color_generators/base_color_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoPattern
   # Color generators
   module ColorGenerators
@@ -14,8 +16,8 @@ module GeoPattern
       # @param [String] color
       #   HTML color string, #0a0a0a
       def initialize(color, seed, creator = Color)
-        @color   = color
-        @seed    = seed
+        @color = color
+        @seed = seed
         @creator = creator
       end
 
@@ -27,23 +29,16 @@ module GeoPattern
       private
 
       def transform(color, seed)
-        hue_offset    = map(seed.to_i(14, 3), 0, 4095, 0, 359)
-        sat_offset    = seed.to_i(17, 1)
-        new_color     = ::Color::RGB.from_html(color).to_hsl
-        new_color.hue = new_color.hue - hue_offset
-
-        if (sat_offset % 2 == 0)
-          new_color.saturation = new_color.saturation + sat_offset
-        else
-          new_color.saturation = new_color.saturation - sat_offset
-        end
-
-        new_color.html
+        hue_offset = map(seed.to_i(14, 3), 0, 4095, 0, 359)
+        sat_offset = seed.to_i(17, 1)
+
+        PatternHelpers.offset_color(color, hue_offset, sat_offset).html
       end
 
       # Ruby implementation of Processing's map function
       # http://processing.org/reference/map_.html
-      def map(value, v_min, v_max, d_min, d_max) # v for value, d for desired
+      # v for value, d for desired
+      def map(value, v_min, v_max, d_min, d_max)
         v_value = value.to_f # so it returns float
 
         v_range = v_max - v_min

data/lib/geo_pattern/color_generators/simple_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoPattern
   # Color generators
   module ColorGenerators

data/lib/geo_pattern/color_preset.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/DuplicateMethods
+
 module GeoPattern
   class ColorPreset
     attr_accessor :color, :base_color, :mode
 
     def initialize(color: nil, base_color: nil)
-      @color      = color
+      @color = color
       @base_color = base_color
     end
 
@@ -24,3 +28,5 @@ module GeoPattern
     end
   end
 end
+
+# rubocop:enable Lint/DuplicateMethods

data/lib/geo_pattern/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoPattern
   # user errors
   class UserError < StandardError; end

data/lib/geo_pattern/geo_pattern_task.rb

@@ -1,5 +1,7 @@
-require 'geo_pattern'
-require 'geo_pattern/rake_task'
+# frozen_string_literal: true
+
+require "geo_pattern"
+require "geo_pattern/rake_task"
 
 module GeoPattern
   # GeoPatternTask
@@ -27,9 +29,9 @@ module GeoPattern
     def initialize(opts = {})
       super
 
-      fail ArgumentError, :data if @options[:data].nil?
+      raise ArgumentError, :data if @options[:data].nil?
 
-      @data             = @options[:data]
+      @data = @options[:data]
       @allowed_patterns = @options[:allowed_patterns]
     end
 
@@ -37,15 +39,15 @@ module GeoPattern
     def run_task(_verbose)
       data.each do |path, string|
         opts = {}
-        path    = File.expand_path(path)
+        path = File.expand_path(path)
 
         if string.is_a?(Hash)
-          input             = string[:input]
-          opts[:patterns]   = string[:patterns] if string.key? :patterns
-          opts[:color]      = string[:color] if string.key? :color
+          input = string[:input]
+          opts[:patterns] = string[:patterns] if string.key? :patterns
+          opts[:color] = string[:color] if string.key? :color
           opts[:base_color] = string[:base_color] if string.key? :base_color
         else
-          fail 'Invalid data structure for Rake Task'
+          raise "Invalid data structure for Rake Task"
         end
 
         pattern = GeoPattern.generate(input, opts)

data/lib/geo_pattern/helpers.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module GeoPattern
   module Helpers
     def require_files_matching_pattern(pattern)
-      Dir.glob(pattern).each { |f| require_relative f }
+      Dir.glob(pattern).sort.each { |f| require_relative f }
     end
 
     # Makes an underscored, lowercase form from the expression in the string.
@@ -10,9 +12,9 @@ module GeoPattern
     #   It's MIT-Licensed
     #
     def underscore(camel_cased_word)
-      return camel_cased_word unless camel_cased_word =~ /[A-Z-]/
+      return camel_cased_word unless /[A-Z-]/.match?(camel_cased_word)
 
-      word = camel_cased_word.to_s
+      word = camel_cased_word.to_s.dup
 
       word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
       word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
@@ -38,8 +40,8 @@ module GeoPattern
     def demodulize(path)
       path = path.to_s
 
-      if i = path.rindex('::')
-        path[(i + 2)..-1]
+      if (i = path.rindex("::"))
+        path[(i + 2)..]
       else
         path
       end

data/lib/geo_pattern/pattern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoPattern
   class Pattern
     private
@@ -48,7 +50,7 @@ module GeoPattern
     # @see #to_data_uri
     # @deprecated
     def uri_image
-      $stderr.puts 'Using "#uri_image" is deprecated as of 1.3.1. Please use "#to_data_uri" instead.'
+      warn 'Using "#uri_image" is deprecated as of 1.3.1. Please use "#to_data_uri" instead.'
 
       to_data_uri
     end
@@ -56,7 +58,7 @@ module GeoPattern
     # @see #to_svg
     # @deprecated
     def svg_string
-      $stderr.puts 'Using "#svg_string" is deprecated as of 1.3.1. Please use "#to_svg" instead.'
+      warn 'Using "#svg_string" is deprecated as of 1.3.1. Please use "#to_svg" instead.'
 
       to_svg
     end
@@ -64,7 +66,7 @@ module GeoPattern
     # @see #to_base64
     # @deprecated
     def base64_string
-      $stderr.puts 'Using "#base64_string" is deprecated as of 1.3.1. Please use "#to_base64" instead.'
+      warn 'Using "#base64_string" is deprecated as of 1.3.1. Please use "#to_base64" instead.'
 
       to_base64
     end
@@ -73,7 +75,7 @@ module GeoPattern
 
     def image
       svg_image.height = height
-      svg_image.width  = width
+      svg_image.width = width
 
       svg_image << background.image if background
       svg_image << structure.image if structure

data/lib/geo_pattern/pattern_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoPattern
   class PatternGenerator
     private
@@ -7,37 +9,37 @@ module GeoPattern
     public
 
     def initialize(string, generator: nil, patterns: nil, base_color: nil, color: nil)
-      $stderr.puts 'Using generator key is deprecated as of 1.3.1' if generator
+      warn "Using generator key is deprecated as of 1.3.1" if generator
 
       requested_patterns = (Array(generator) | Array(patterns)).flatten.compact
 
       pattern_preset = PatternPreset.new(
-        fill_color_dark: '#222',
-        fill_color_light: '#ddd',
-        stroke_color: '#000',
+        fill_color_dark: "#222",
+        fill_color_light: "#ddd",
+        stroke_color: "#000",
         stroke_opacity: 0.02,
         opacity_min: 0.02,
         opacity_max: 0.15
       )
 
       color_preset = ColorPreset.new(
-        base_color: '#933c3c'
+        base_color: "#933c3c"
       )
-      color_preset.color      = color if color
+      color_preset.color = color if color
       color_preset.base_color = base_color if base_color
 
       seed = Seed.new(string)
 
-      pattern_validator    = PatternValidator.new
+      pattern_validator = PatternValidator.new
       pattern_validator.validate(requested_patterns)
 
-      pattern_sieve        = PatternSieve.new(requested_patterns, seed)
+      pattern_sieve = PatternSieve.new(requested_patterns, seed)
 
       @background_generator = BackgroundGenerators::SolidGenerator.new(seed, color_preset)
-      @structure_generator  = begin
-                                generator_klass = pattern_sieve.fetch
-                                generator_klass.new(seed, pattern_preset)
-                              end
+      @structure_generator = begin
+        generator_klass = pattern_sieve.fetch
+        generator_klass.new(seed, pattern_preset)
+      end
     end
 
     def generate

data/lib/geo_pattern/pattern_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoPattern
   module PatternHelpers
     def hex_val(hash, index, length)
@@ -6,7 +8,8 @@ module GeoPattern
 
     # Ruby implementation of Processing's map function
     # http://processing.org/reference/map_.html
-    def map(value, v_min, v_max, d_min, d_max) # v for value, d for desired
+    # v for value, d for desired
+    def map(value, v_min, v_max, d_min, d_max)
       v_value = value.to_f # so it returns float
 
       v_range = v_max - v_min
@@ -19,18 +22,33 @@ module GeoPattern
     end
 
     def html_to_rgb_for_string(seed, base_color)
-      hue_offset     = map(seed.to_i(14, 3), 0, 4095, 0, 359)
-      sat_offset     = seed.to_i(17, 1)
-      base_color     = ::Color::RGB.from_html(base_color).to_hsl
-      base_color.hue = base_color.hue - hue_offset
+      hue_offset = map(seed.to_i(14, 3), 0, 4095, 0, 359)
+      sat_offset = seed.to_i(17, 1)
+
+      generate_rgb_string(offset_color(base_color, hue_offset, sat_offset))
+    end
+
+    # Rotates the hue and shifts the saturation of an HTML color, returning a
+    # Color::RGB. Color objects are immutable as of color 2.0, so this builds a
+    # new color instead of mutating one in place.
+    def offset_color(html_color, hue_offset, sat_offset)
+      hsl = ::Color::RGB.from_html(html_color).to_hsl
+
+      hue = (hsl.hue - hue_offset) / 360.0
+      hue += 1.0 if hue < 0.0
+      hue -= 1.0 if hue > 1.0
 
-      if (sat_offset % 2 == 0)
-        base_color.saturation = base_color.saturation + sat_offset
+      saturation = if sat_offset % 2 == 0
+        hsl.saturation + sat_offset
       else
-        base_color.saturation = base_color.saturation - sat_offset
+        hsl.saturation - sat_offset
       end
 
-      generate_rgb_string(base_color.to_rgb)
+      ::Color::HSL.from_fraction(
+        hue.clamp(0.0, 1.0),
+        (saturation / 100.0).clamp(0.0, 1.0),
+        hsl.l
+      ).to_rgb
     end
 
     def generate_rgb_string(rgb)
@@ -38,9 +56,9 @@ module GeoPattern
       g = (rgb.g * 255).round
       b = (rgb.b * 255).round
 
-      format('rgb(%d, %d, %d)', r, g, b)
+      format("rgb(%<r>d, %<g>d, %<b>d)", r: r, g: g, b: b)
     end
 
-    module_function :hex_val, :map, :html_to_rgb, :html_to_rgb_for_string, :generate_rgb_string
+    module_function :hex_val, :map, :html_to_rgb, :html_to_rgb_for_string, :offset_color, :generate_rgb_string
   end
 end

data/lib/geo_pattern/pattern_preset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoPattern
   class PatternPreset
     private
@@ -10,7 +12,7 @@ module GeoPattern
       @options = options
     end
 
-    [:fill_color_dark, :fill_color_light, :stroke_color, :stroke_opacity, :opacity_min, :opacity_max].each do |m|
+    %i[fill_color_dark fill_color_light stroke_color stroke_opacity opacity_min opacity_max].each do |m|
       define_method m do
         options[m]
       end

data/lib/geo_pattern/pattern_sieve.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoPattern
   class PatternSieve
     private
@@ -8,11 +10,11 @@ module GeoPattern
 
     def initialize(requested_patterns, seed, pattern_store = PatternStore.new)
       @requested_patterns = requested_patterns
-      @seed               = seed
-      @pattern_store      = pattern_store
+      @seed = seed
+      @pattern_store = pattern_store
 
       @available_patterns = determine_available_patterns
-      @index              = determine_index
+      @index = determine_index
     end
 
     def fetch