icodi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c658ed87b6473e55b975104c7578b27ee558df59623a710d89637fd168acb528
-  data.tar.gz: e5c37860c467df8b4daa3046352812ee036cf3f5197530aa8c83f4d8ae76d972
+  metadata.gz: 9d272a6dc8d9e595006ce36f72421892a2381cb0d51285e2390143d257c9f119
+  data.tar.gz: e7fc61dfee1364269ffe07d4100b14fa7b48ec100680ed5094b6e40b673ea6c3
 SHA512:
-  metadata.gz: c8f9a6b9bee3066dffa76ca91def8f199aed7fc15b0c21828b5f6add814e464a02e4138eac8dffb1b64dca07dc17870e8d23765c481db5112103c8caf1c67813
-  data.tar.gz: 1da2da19a46676aa49a7b4dd01eb90ba5d7f86703aaf8946febbb5777c709128dc0d04b6c4da431e560ffbdc00c1ac242feca8bc6fe685761807349f374a2cac
+  metadata.gz: 86b7e257b95b0ead2d4ec44ee27edb3187cafa18ba519f99776831520502294b6a47c80732cc71abbf5f3e544a17307f449d66153391b8d806c7df03298a6b86
+  data.tar.gz: 68fa6d9f3ed793c99f3cdce6437781026e2bd44c8192bae60e8925988ec8b496840083bbf4a5c2314b1a6fa33f4069e0d150413928e91054fe6d35f71d54bdd4

data/README.md

@@ -5,6 +5,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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0b74be3877413501c7a9/maintainability)](https://codeclimate.com/github/DannyBen/icodi/maintainability)
 
 ---
 
@@ -13,6 +14,16 @@ Generate repeatable random SVG icons from any string, similar to
 
 ---
 
+Table of Contents
+--------------------------------------------------
+
+- [Installation](#installation)
+- [Examples](#examples)
+- [Usage](#usage)
+- [Options](#options)
+- [Using with Sinatra](#using-with-sinatra)
+
+
 Installation
 --------------------------------------------------
 
@@ -23,33 +34,41 @@ Installation
 Examples
 --------------------------------------------------
 
-### Grid: 5x5, Mirror: X (default options)
+### Grid: 5x5, Mirror: X (default settings)
 
-![sample](assets/sample-strip-default.svg)
+![strip1](assets/strip_default.svg)
 
-### Grid: 6x6, Mirror: Y
+### Grid: 6x6, Mirror: Y, Stroke: 4
 
-![sample](assets/sample-strip-6y.svg)
+![strip2](assets/strip_mirror_y.svg)
 
-### Grid: 8x8, Mirror: X/Y, Density: 0.3
+### Grid: 8x8, Stroke: 7, Density: 0.3
 
-![sample](assets/sample-strip-8xylow.svg)
+![strip3](assets/strip_thick_stroke.svg)
 
-### Grid: 8x8, Mirror: X/Y, Density: 0.8
+### Grid: 7x7, Mirror: X/Y, Stroke: 3, Density: 0.8
 
-![sample](assets/sample-strip-8xyhigh.svg)
+![strip4](assets/strip_mirror_both.svg)
+
+### Grid: 5x5, Jitter: 0.9, Stroke: 2
+
+![strip4](assets/strip_jitter.svg)
 
 ### Increasing Stroke: 0.1 - 5.0
 
-![sample](assets/sample-strip-stroke.svg)
+![strip5](assets/strip_strokes.svg)
 
 ### Increasing Density: 0.3 - 0.8
 
-![sample](assets/sample-strip-density.svg)
+![strip6](assets/strip_densities.svg)
+
+### Increasing Jitter: 0 - 1.0
+
+![strip6](assets/strip_jitters.svg)
 
 ### Mirror Styles: X, Y, Both, None
 
-![sample](assets/sample-strip-mirrors.svg)
+![strip7](assets/strip_mirrors.svg)
 
 
 Usage
@@ -98,13 +117,23 @@ Parameter   | Default    | Type    | Description
 ------------|------------|---------|---------------------
 `pixels`    | `5`        | Integer | Grid size.
 `mirror`    | `:x`       | Symbol  | Mirroring mode: `:x`, `:y`, `:both` or `:none`.
-`color`     | Deterministic Random  | String | A color string for the pixels.
+`color`     | Deterministic Random | String | A color string for the pixels.
 `density`   | `0.5`      | Float   | A value between 0 and 1 representing the chance for a pixel to be drawn. Lower values mean less pixels.
 `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`).
 `template`  | `:default` | Symbol/String | SVG template to use. Can be `:default`, `:html` or a path to a file. Read more on [Victor SVG Templates].
 
 ---
 
+
+Using with Sinatra
+--------------------------------------------------
+
+To create a Sinatra server that serves Icodi images, see the 
+[server.rb](server.rb) example code.
+
+
+
 [GitHub identicons]: https://blog.github.com/2013-08-14-identicons/
 [Victor SVG Templates]: https://github.com/DannyBen/victor#svg-templates

data/lib/icodi.rb

@@ -6,49 +6,50 @@ class Icodi < Victor::SVGBase
 
   def initialize(text = nil, options = {})
     text, options = nil, text if text.is_a? Hash
-    @text, @options = text, options
-    super template: template, viewBox: "0 0 #{size} #{size}"
+    
+    @text = text
+    @options = default_options.merge options
 
-    first_random_hit
+    super template: template, viewBox: "0 0 #{size} #{size}", clip_path: "url(#rect)"
+    
     generate
   end
 
-  def template
-    options[:template] ||= :default
+  def method_missing(method_name, *_args, &_block)
+    respond_to?(method_name) ? options[method_name] : super
   end
 
-  def pixels
-    options[:pixels] ||= 5
+  def respond_to?(method_name, include_private = false)
+    options.has_key?(method_name) ? true : super
   end
 
-  def density
-    options[:density] ||= 0.5
-  end
-
-  def stroke
-    options[:stroke] ||= 0.1
-  end
-
-  def background
-    options[:background] ||= '#fff'
-  end
+private
 
-  def color
-    options[:color] ||= "#%06x" % (random.rand * 0xffffff)
+  def default_options
+    {
+      template: :default, 
+      pixels: 5,
+      density: 0.5,
+      stroke: 0.1,
+      background: '#fff',
+      color: random_color,
+      mirror: :x,
+      jitter: 0,
+    }
   end
 
-  def mirror
-    options[:mirror] ||= :x
+  def random_color
+    "#%06x" % (random(:color).rand * 0xffffff)
   end
 
-private
-
   def seed(string)
     Digest::MD5.hexdigest(string).to_i(16)
   end
 
-  def random
-    @random ||= (text ? Random.new(seed(text)) : Random.new)
+  def random(set = nil)
+    @random_sets ||= {}
+    set ||= :default
+    @random_sets[set] ||= (text ? Random.new(seed(text)) : Random.new)
   end
 
   def size
@@ -59,29 +60,33 @@ private
     @style ||= { stroke: color, stroke_width: stroke }
   end
 
-  def mirror_x
+  def mirror_x?
     [:x, :both].include? mirror
   end
 
-  def mirror_y
+  def mirror_y?
     [:y, :both].include? mirror
   end
 
-  def mirror_both
+  def mirror_both?
     mirror == :both
   end
 
-  def first_random_hit
-    options[:color] ? random.rand : color
-  end
-
   def generate
     element :rect, x: 0, y: 0, width: size, height: size, fill: background
+    element :defs do
+      element :clipPath, id: :clipper do
+        element :rect, width: size, height: size
+      end
+    end
+
     half = (pixels / 2.0).round
-    x = mirror_x ? half : pixels
-    y = mirror_y ? half : pixels
+    x = mirror_x? ? half : pixels
+    y = mirror_y? ? half : pixels
 
-    draw x, y
+    element :g, clip_path: "url(#clipper)" do
+      draw x, y
+    end
   end  
 
   def draw(x_times, y_times)
@@ -93,14 +98,42 @@ private
   end  
 
   def add_pixels(x, y)
+    x, y = add_jitter x, y
+
     draw_pixel x, y
-    draw_pixel pixels-1-x, y if mirror_x and x != pixels/2
-    draw_pixel x, pixels-1-y if mirror_y and y != pixels/2
-    draw_pixel pixels-1-x, pixels-1-y if mirror_both and x != pixels/2 and y != pixels/2
+    draw_pixel mirror_value(x), y if mirror? x: x
+    draw_pixel x, mirror_value(y) if mirror? y: y
+    draw_pixel mirror_value(x), mirror_value(y) if mirror? x: x, y: y
+  end
+
+  def mirror?(x: nil, y: nil)
+    if x and y
+      mirror_both? and !mid?(x: x) and !mid?(y: y)
+    elsif x
+      mirror_x? and !mid? x: x
+    elsif y
+      mirror_y? and !mid? y: y
+    end
+  end
+
+  def mid?(x: nil, y: nil)
+    x ? x == pixels/2 : y ? y == pixels/2 : nil
+  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]
   end
 
   def draw_pixel(x, y)
     element :rect, x: x*10, y: y*10, width: 10, height: 10, fill: color, style: style
   end
 
+  def mirror_value(value)
+    pixels - 1 - value
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icodi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-17 00:00:00.000000000 Z
+date: 2018-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: victor