icodi 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d272a6dc8d9e595006ce36f72421892a2381cb0d51285e2390143d257c9f119
-  data.tar.gz: e7fc61dfee1364269ffe07d4100b14fa7b48ec100680ed5094b6e40b673ea6c3
+  metadata.gz: f552185f36c92756e8ebb28fe15ca0ac2efdf821934ada7e115fef570658687f
+  data.tar.gz: 3cc2ff20a4fbfa8137a75e76651e1362af861712a0099cb455aca9a0e7632996
 SHA512:
-  metadata.gz: 86b7e257b95b0ead2d4ec44ee27edb3187cafa18ba519f99776831520502294b6a47c80732cc71abbf5f3e544a17307f449d66153391b8d806c7df03298a6b86
-  data.tar.gz: 68fa6d9f3ed793c99f3cdce6437781026e2bd44c8192bae60e8925988ec8b496840083bbf4a5c2314b1a6fa33f4069e0d150413928e91054fe6d35f71d54bdd4
+  metadata.gz: a8b4b6538723c593eecb1e87a3b550a855a412c48fc81357e9031bef096585828e47f74e1aa4db2eecb62925651ab21380632412ee61310a5be434d6bdf6cfe9
+  data.tar.gz: 709621cd1d7cf475644f721b9f8f2d42f35eaa2ed47eca512645cb6b55f615e2a1eb7c3a197e6e98a9f01f1ef9aa262e4fdbdb09eaea6e0ad7f10047f9273841

data/README.md

@@ -4,7 +4,7 @@ Icodi - Deterministic Random SVG Icon Generator
 ==================================================
 
 [![Gem Version](https://badge.fury.io/rb/icodi.svg)](https://badge.fury.io/rb/icodi)
-[![Build Status](https://travis-ci.com/DannyBen/icodi.svg?branch=master)](https://travis-ci.com/DannyBen/icodi)
+[![Build Status](https://github.com/DannyBen/icodi/workflows/Test/badge.svg)](https://github.com/DannyBen/icodi/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/0b74be3877413501c7a9/maintainability)](https://codeclimate.com/github/DannyBen/icodi/maintainability)
 
 ---
@@ -18,10 +18,12 @@ Table of Contents
 --------------------------------------------------
 
 - [Installation](#installation)
+- [Demo](#demo)
 - [Examples](#examples)
 - [Usage](#usage)
 - [Options](#options)
 - [Using with Sinatra](#using-with-sinatra)
+- [Contributing / Support](#contributing--support)
 
 
 Installation
@@ -31,6 +33,13 @@ Installation
 
 
 
+Demo
+--------------------------------------------------
+
+Visit the [Icodi Playground] to experiment with the parameters.
+
+
+
 Examples
 --------------------------------------------------
 
@@ -122,6 +131,7 @@ Parameter   | Default    | Type    | Description
 `stroke`    | `0.1`      | Float   | Width of the border around each pixel. Note that each pixel is a 10x10 box, so a stroke of 1 means it will take 10% of the box. Higher values generate more overlap between the pixels.
 `jitter`    | `0`        | Float   | A value between 0 and 1 representing the chance for a pixel to be dislocated by half of its size in a random direction.
 `background`| `#fff`     | String  | A named SVG color string (`blue`, `yellow` etc.) or RGB color (for example `#dddddd`).
+`id`        | `icodi`    | String  | The ID to assign the SVG object. Normally this should not matter, but if you intend to embed this icon in an HTML, or in another SVG, this can be useful.
 `template`  | `:default` | Symbol/String | SVG template to use. Can be `:default`, `:html` or a path to a file. Read more on [Victor SVG Templates].
 
 ---
@@ -131,9 +141,18 @@ Using with Sinatra
 --------------------------------------------------
 
 To create a Sinatra server that serves Icodi images, see the 
-[server.rb](server.rb) example code.
+[config.ru](config.ru) example code.
 
 
+Contributing / Support
+--------------------------------------------------
+
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+---
 
 [GitHub identicons]: https://blog.github.com/2013-08-14-identicons/
 [Victor SVG Templates]: https://github.com/DannyBen/victor#svg-templates
+[Icodi Playground]: https://icodi.dannyb.co/sandbox
+[issues]: https://github.com/DannyBen/icodi/issues

data/lib/icodi/options.rb

@@ -0,0 +1,68 @@
+module IcodiCore
+  module Options
+    def default_options
+      {
+        pixels:     5,
+        density:    0.5,
+        stroke:     0.1,
+        background: '#fff',
+        color:      random_color,
+        mirror:     :x,
+        jitter:     0,
+        id:         :icodi,
+      }
+    end
+
+    def background
+      options[:background]
+    end
+
+    def color
+      options[:color]
+    end
+
+    def density
+      options[:density]
+    end
+
+    def id
+      options[:id]
+    end
+
+    def jitter
+      options[:jitter]
+    end
+
+    def mirror
+      options[:mirror]
+    end
+
+    def mirror_x?
+      %i[x both].include? mirror
+    end
+
+    def mirror_y?
+      %i[y both].include? mirror
+    end
+
+    def mirror_both?
+      mirror == :both
+    end
+
+    def pixels
+      options[:pixels]
+    end
+
+    def size
+      @size ||= pixels * 10
+    end
+
+    def stroke
+      options[:stroke]
+    end
+
+    def style
+      @style ||= { stroke: color, stroke_width: stroke }
+    end
+  end
+end

data/lib/icodi/randomization.rb

@@ -0,0 +1,16 @@
+module IcodiCore
+  module Randomization
+    def seed(string)
+      Digest::MD5.hexdigest(string).to_i(16)
+    end
+
+    def random(set = nil)
+      set ||= :default
+      random_sets[set] ||= (text ? Random.new(seed(text)) : Random.new)
+    end
+
+    def random_sets
+      @random_sets ||= {}
+    end
+  end
+end

data/lib/icodi.rb

@@ -1,81 +1,38 @@
 require 'victor'
 require 'digest/md5'
+require 'icodi/options'
+require 'icodi/randomization'
 
 class Icodi < Victor::SVGBase
-  attr_reader :text, :options
-
-  def initialize(text = nil, options = {})
-    text, options = nil, text if text.is_a? Hash
-    
-    @text = text
-    @options = default_options.merge options
-
-    super template: template, viewBox: "0 0 #{size} #{size}", clip_path: "url(#rect)"
-    
-    generate
-  end
-
-  def method_missing(method_name, *_args, &_block)
-    respond_to?(method_name) ? options[method_name] : super
-  end
-
-  def respond_to?(method_name, include_private = false)
-    options.has_key?(method_name) ? true : super
-  end
-
-private
-
-  def default_options
-    {
-      template: :default, 
-      pixels: 5,
-      density: 0.5,
-      stroke: 0.1,
-      background: '#fff',
-      color: random_color,
-      mirror: :x,
-      jitter: 0,
-    }
-  end
+  include IcodiCore::Options
+  include IcodiCore::Randomization
 
-  def random_color
-    "#%06x" % (random(:color).rand * 0xffffff)
-  end
+  attr_reader :text, :options
 
-  def seed(string)
-    Digest::MD5.hexdigest(string).to_i(16)
-  end
+  def initialize(text = nil, opts = {})
+    if text.is_a? Hash
+      opts = text
+      text = nil
+    end
 
-  def random(set = nil)
-    @random_sets ||= {}
-    set ||= :default
-    @random_sets[set] ||= (text ? Random.new(seed(text)) : Random.new)
-  end
+    svg_template = opts.delete :template
 
-  def size
-    @size ||= pixels * 10
-  end
-
-  def style
-    @style ||= { stroke: color, stroke_width: stroke }
-  end
+    @text = text
+    @options = default_options.merge opts
 
-  def mirror_x?
-    [:x, :both].include? mirror
-  end
+    super template: svg_template, viewBox: "0 0 #{size} #{size}", id: id
 
-  def mirror_y?
-    [:y, :both].include? mirror
+    generate
   end
 
-  def mirror_both?
-    mirror == :both
-  end
+private
 
   def generate
+    clip_path_id = "#{id}-#{random_id}"
+
     element :rect, x: 0, y: 0, width: size, height: size, fill: background
     element :defs do
-      element :clipPath, id: :clipper do
+      element :clipPath, id: clip_path_id do
         element :rect, width: size, height: size
       end
     end
@@ -84,10 +41,10 @@ private
     x = mirror_x? ? half : pixels
     y = mirror_y? ? half : pixels
 
-    element :g, clip_path: "url(#clipper)" do
+    element :g, clip_path: "url(##{clip_path_id})" do
       draw x, y
     end
-  end  
+  end
 
   def draw(x_times, y_times)
     y_times.times do |y|
@@ -95,7 +52,7 @@ private
         add_pixels x, y if random.rand < density
       end
     end
-  end  
+  end
 
   def add_pixels(x, y)
     x, y = add_jitter x, y
@@ -106,8 +63,28 @@ private
     draw_pixel mirror_value(x), mirror_value(y) if mirror? x: x, y: y
   end
 
+  def add_jitter(x, y)
+    if jitter.positive? && (random(:jitter).rand < jitter)
+      add_jitter! x, y
+    else
+      [x, y]
+    end
+  end
+
+  def add_jitter!(x, y)
+    x += random_jitter unless mirror_x? && mid?(x: x)
+    y += random_jitter unless mirror_y? && mid?(y: y)
+    [x, y]
+  end
+
+  def draw_pixel(x, y)
+    element :rect, x: x * 10, y: y * 10, width: 10, height: 10, fill: color, style: style
+  end
+
+  # Drawing Utilities
+
   def mirror?(x: nil, y: nil)
-    if x and y
+    if x && y
       mirror_both? and !mid?(x: x) and !mid?(y: y)
     elsif x
       mirror_x? and !mid? x: x
@@ -117,23 +94,26 @@ private
   end
 
   def mid?(x: nil, y: nil)
-    x ? x == pixels/2 : y ? y == pixels/2 : nil
+    if x
+      x == pixels / 2
+    elsif y
+      y == pixels / 2
+    end
   end
 
-  def add_jitter(x, y)
-    return [x, y] unless jitter > 0 and random(:jitter).rand < jitter
-    
-    x += [0, 0.5, -0.5][random(:jitter).rand(3)] unless mirror_x? and mid? x: x
-    y += [0, 0.5, -0.5][random(:jitter).rand(3)] unless mirror_y? and mid? y: y
-    [x, y]
+  def mirror_value(value)
+    pixels - 1 - value
   end
 
-  def draw_pixel(x, y)
-    element :rect, x: x*10, y: y*10, width: 10, height: 10, fill: color, style: style
+  def random_id
+    random(:nonvisual).rand(9_999_999)
   end
 
-  def mirror_value(value)
-    pixels - 1 - value
+  def random_jitter
+    [0, 0.5, -0.5][random(:jitter).rand(3)]
   end
 
+  def random_color
+    '#%06x' % (random(:color).rand * 0xffffff)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icodi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-18 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: victor
@@ -32,10 +32,15 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/icodi.rb
+- lib/icodi/options.rb
+- lib/icodi/randomization.rb
 homepage: https://github.com/dannyben/icodi
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/DannyBen/icodi/issues
+  source_code_uri: https://github.com/DannyBen/icodi
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -44,15 +49,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.4.7
 signing_key: 
 specification_version: 4
 summary: Deterministic Random SVG Icon Generator