icodi 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b1bdd7935d65c413f8cf5045617e65fdc577ec29791d6b6d057f5136b09ae21
-  data.tar.gz: b2fe8269f46af45a14fe623cec635db2411100c14d27f971cb72da55d37ec356
+  metadata.gz: 0a3f414c62dea517e5a15996bffc590270bc185afc1bcf95258ba8a081d16891
+  data.tar.gz: 5407c73c9d3213d87a7b1f359efb64e0bfa57c8b1e72feb2ef859480c1499d6c
 SHA512:
-  metadata.gz: 1c10feaef8ce4d94eb903c7470fb305f6438f81ffca59f4c7fd690ee04c86bcf38af06360eebbde832282a5789cd561742309546e256c5aa8a8a38b43a54104e
-  data.tar.gz: 80a364f7250b254af25de1dfcc2bcf3a820fc5cb27d6c0608457d27bb45092cec01bc3721f9c37f9a7211d53352277411655fa7c1c49ca3fbb3f9e9804ebaf8a
+  metadata.gz: 27d92abc7cceb5ca423e063877a8e154ca1cf297ea08310b42574c6e829b8b2d191f59fb11910f475647c8a8fd3428dfbbeb04530937f3475cf2e77095363a08
+  data.tar.gz: 2d86e71a27ae1cbee43b2834ae328d9cc7d917e978c3f8bfd874fa1718674cd4ace2783548ec7372a26e5c07fb21d65526481ce9f34130493724db7a56720f67

data/README.md

@@ -1,3 +1,5 @@
+![logo](assets/logo.svg)
+
 Icodi - Deterministic Random SVG Icon Generator
 ==================================================
 
@@ -6,8 +8,8 @@ Icodi - Deterministic Random SVG Icon Generator
 
 ---
 
-Generate repeatable random SVG icons from any string, similar to GitHub's 
-identicons.
+Generate repeatable random SVG icons from any string, similar to 
+[GitHub identicons].
 
 ---
 
@@ -18,7 +20,91 @@ Installation
 
 
 
+Examples
+--------------------------------------------------
+
+### Grid: 5x5, Mirror: X (default options)
+
+![sample](assets/sample-strip-default.svg)
+
+### Grid: 6x6, Mirror: Y
+
+![sample](assets/sample-strip-6y.svg)
+
+### Grid: 8x8, Mirror: X/Y, Density: 0.3
+
+![sample](assets/sample-strip-8xylow.svg)
+
+### Grid: 8x8, Mirror: X/Y, Density: 0.8
+
+![sample](assets/sample-strip-8xyhigh.svg)
+
+### Increasing Stroke: 0.1 - 5.0
+
+![sample](assets/sample-strip-stroke.svg)
+
+### Increasing Density: 0.3 - 0.8
+
+![sample](assets/sample-strip-density.svg)
+
+### Mirror Styles: X, Y, Both, None
+
+![sample](assets/sample-strip-mirrors.svg)
+
+
 Usage
 --------------------------------------------------
 
-TODO
+This is the general usage pattern:
+
+```ruby
+require 'icodi'
+
+# initialize with optional text and options
+icon = Icodi.new text, options
+
+# get the SVG string
+icon.render
+
+# or save to SVG file
+icon.save 'logo'
+```
+
+Generate a random icon with the default options, and save it to `icon.svg`:
+
+```ruby
+icon = Icodi.new
+icon.save 'icon'
+```
+
+Generate persistent random icon (same input generates the same output):
+
+```ruby
+icon = Icodi.new "any string"
+icon.save 'icon'
+```
+
+Options
+--------------------------------------------------
+
+Options can be provided as the first or second argument:
+
+```ruby
+Icodi.new "any string", pixels: 8, density: 0.3
+Icodi.new pixels: 8, density: 0.3, stroke: 2
+```
+
+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.
+`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.
+`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].
+
+---
+
+[GitHub identicons]: https://blog.github.com/2013-08-14-identicons/
+[Victor SVG Templates]: https://github.com/DannyBen/victor#svg-templates

data/lib/icodi.rb

@@ -8,6 +8,8 @@ class Icodi < Victor::SVGBase
     text, options = nil, text if text.is_a? Hash
     @text, @options = text, options
     super template: template, viewBox: "0 0 #{size} #{size}"
+
+    first_random_hit
     generate
   end
 
@@ -69,42 +71,36 @@ private
     mirror == :both
   end
 
+  def first_random_hit
+    options[:color] ? random.rand : color
+  end
+
   def generate
-    color # always randomize color first
     element :rect, x: 0, y: 0, width: size, height: size, fill: background
     half = (pixels / 2.0).round
     x = mirror_x ? half : pixels
     y = mirror_y ? half : pixels
 
-    draw matrix x, y
+    draw x, y
   end  
 
-  def draw(grid)
-    grid.each_with_index do |row, y|
-      row.each_with_index do |enabled, x|
-        if enabled
-          add_pixel x, y
-          add_pixel pixels-1-x, y if mirror_x and x != pixels/2
-          add_pixel x, pixels-1-y if mirror_y and y != pixels/2
-          add_pixel pixels-1-x, pixels-1-y if mirror_both and x != pixels/2 and y != pixels/2
-        end
+  def draw(x_times, y_times)
+    y_times.times do |y|
+      x_times.times do |x|
+        add_pixels x, y if random.rand < density
       end
     end
   end  
 
-  def matrix(xtimes, ytimes)
-    matrix = []
-    ytimes.times do |y|
-      matrix[y] = []
-      xtimes.times do |x|
-        matrix[y][x] = random.rand < density
-      end
-    end
-
-    matrix
+  def add_pixels(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
   end
 
-  def add_pixel(x, y)
+  def draw_pixel(x, y)
     element :rect, x: x*10, y: y*10, width: 10, height: 10, fill: color, style: style
   end
+
 end

metadata

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