circule 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9449a7b91abcb3058201ee66d2c44925ab3cadd958421731a0269de135556e09
-  data.tar.gz: f6bc4ede2a8ef059e4cea8e9a02a40203c157b59dd4ba2a4e3e573627b8c1b0b
+  metadata.gz: d43165d03d518eb31001ab176b1200778d528a8586fb984b63946bd728c79051
+  data.tar.gz: 5a9fc83e8949085d4fcf756bef38d298d8272bfb59eeb602295a68b04fa41e61
 SHA512:
-  metadata.gz: 8ae5266a7208c0b6dfacc7e6dcacf0f35b04aa57a0c80ce445e5c529d8eb329c4547de66ab56830f511116b9ba27299ed09d5c0e2f861d73248fa1ccb1b7cf6d
-  data.tar.gz: 4672cce80a11799eeccc8ef1d29a93fe4d4a144cf4aaeea21a520fe7bb7ff7627b94c5feef3edad7269adfbfa8e087af5bde82c1d5e356485283e155dd4452f6
+  metadata.gz: 34c059aea8a7919bd2c2316b518f5eeb47c4884cc06082f4defed64e736b1263aa4bf8c5dcde9d3956b1f2e2e433d258d7b3b75c59c330c22959e2cc2bbfc0da
+  data.tar.gz: d48266b32c4b2e876de388a1c5485e4f671159f958e2e1b6023c9b3468714e58b0b6c59d06fb813114fcb05c5d9d9480f103b836a2f53b2770c79e2b23e96ef5

data/.rubocop.yml

@@ -1,13 +1,93 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/LeadingCommentSpace:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 160
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: false
+
+Layout/SpaceBeforeSemicolon:
+  Enabled: false
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: false
+
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+Lint/EmptyWhen:
+  Enabled: false
+
+Lint/Void:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+  EnforcedStyleForLeadingUnderscores: required
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  BracesRequiredMethods: [button, command, entry, frame, label, spinbox]
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
 
 Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
+  EnforcedStyle: single_quotes
 
 Style/StringLiteralsInInterpolation:
-  Enabled: true
   EnforcedStyle: double_quotes
 
-Layout/LineLength:
-  Max: 120
+Style/TrailingCommaInArguments:
+  Enabled: false
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/Gemfile

@@ -10,3 +10,7 @@ gem 'rake', '~> 13.0'
 gem 'minitest', '~> 5.0'
 
 gem 'rubocop', '~> 1.7'
+gem 'rubocop-minitest'
+gem 'rubocop-rake'
+
+#em 'glimmer-dsl-tk'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    circule (0.1.0)
+    circule (0.1.4)
       chunky_png
 
 GEM
@@ -28,6 +28,10 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
+    rubocop-minitest (0.15.2)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.1.0)
 
@@ -39,6 +43,8 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.7)
+  rubocop-minitest
+  rubocop-rake
 
 BUNDLED WITH
    2.2.27

data/README.md

@@ -1,11 +1,18 @@
 # Circule
 
-Welcome to your new gem! In this directory, you'll find the files you
-need to be able to package up your Ruby library into a gem. Put your
-Ruby code in the file `lib/circule`. To experiment with that code, run
-`bin/console` for an interactive prompt.
+Generate an icon of overlapping circles derived from a hash.
 
-TODO: Delete this and the text above, and describe your gem
+1. Slice the hash into 16-bit slices starting at bit `bn`, stepping `s`
+   bits at a time, ending after bit `bn`.
+
+2. From each slice define a circle such that bits 0 through 4 is the `x`
+   coordinate of the center, bits 5 through 9 is the `y` coordinate of
+   the center, and bits 10 through 15 is the radius of the circle.
+
+3. Each pixel in the output will be colored based on the number of
+   circles that point is inside.
+
+The [demo video](circule-demo.mp4) shows how the final image is composed.
 
 ## Installation
 
@@ -25,7 +32,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### CLI Options
+
+| Short Option | Long Option   | Description                      |
+|--------------|---------------|----------------------------------|
+| -h HEXSTRING | --hex         | Use this hash                    |
+| -b INTEGER   | --btc-block   | Use hash from this bitcoin block |
+| -0 INTEGER   | --bit0        | Starting bit                     |
+| -s INTEGER   | --step        | Step bit                         |
+| -n INTEGER   | --bitn        | Starting bit                     |
+| -c INTEGER   | --canvas      | Canvas size                      |
+| -x INTEGER   | --ox          | Offset x                         |
+| -y INTEGER   | --oy          | Offset y                         |
+| -z INTEGER   | --zoom        | Zoom in GUI                      |
+| -f FILENAME  | --file        | Use hash from file               |
+| -s FILENAME  | --save        | Save image to file               |
+| -g           | --gui         | Run GUI (requires glimmer & tk)  |
+| -i           | --interactive | Run GUI with pry                 |
+
+### CLI Example(s)
+
+The icon for this project on GitLab:
+```
+$ echo -n circule | sha256sum
+4b9ae43c4e15486ce131f733eff14547764623d27aa5d1d9aff45b67528f0b60  -
+
+$ circule -h 4b9ae43c4e15486ce131f733eff14547764623d27aa5d1d9aff45b67528f0b60 -s /tmp/circule.png
+```
 
 ## Development
 
@@ -41,7 +74,7 @@ push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at
+Bug reports and pull requests are welcome on GitLab at
 https://gitlab.com/fjc/circule.
 
 ## License

data/circule.gemspec

@@ -8,20 +8,20 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Frank J. Cameron']
   spec.email         = ['fjc@fastmail.net']
 
-  spec.summary       = ''
+  spec.summary       = 'Generate an icon of overlapping circles derived from a hash.'
   spec.homepage      = 'https://gitlab.com/fjc/circule'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.metadata['homepage_uri'] = spec.homepage
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) {
     `git ls-files -z`.split("\x0").reject do |f|
       (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
-  end
+  }
 
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }

data/exe/circule

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'circule'
 require 'optparse'
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = ''
+  opts.banner = 'Generate an icon of overlapping circles derived from a hash.'
 
   opts.on('-h HEXSTRING', '--hex', 'Use this hash') do |h|
     options[:hex] = h
@@ -71,7 +72,7 @@ if options[:gui]
   gui.canvas    = options[:canvas] if options[:canvas]
   gui.ox        = options[:ox]     if options[:ox]
   gui.oy        = options[:oy]     if options[:oy]
-  gui.zoom      = options[:zoom]   if options[:zoom]
+  gui.scale     = options[:zoom]   if options[:zoom]
 
   gui.open options[:file] if options[:file]
 
@@ -83,6 +84,7 @@ if options[:gui]
 
   if options[:interactive]
     require 'pry'
+    require 'trace_eval' rescue nil
     Thread.new do gui.pry ensure `reset` end
   end
 
@@ -92,7 +94,7 @@ else
   when nil
   when '-'
     require 'digest'
-    options[:hex] = Digest::SHA256.hexdigest STDIN.read
+    options[:hex] = Digest::SHA256.hexdigest $stdin.read
   else
     require 'digest'
     options[:hex] = Digest::SHA256.hexdigest File.read(options[:file])
@@ -113,7 +115,7 @@ else
     case options[:save]
     when nil
     when '-'
-      circule.image.write STDOUT
+      circule.image.write $stdout
     else
       circule.image.save options[:save]
     end

data/lib/circule/gui.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../circule'
 
 require 'digest'
@@ -10,6 +12,7 @@ rescue LoadError
   warn "Could not find gem 'glimmer-dsl-tk' in locally installed gems."
 end
 
+# Glimmer Tk GUI for Circule
 class Circule::GUI
   include Glimmer
 
@@ -57,7 +60,8 @@ class Circule::GUI
 
     width  = image.width * @scale.to_i
     height = image.height * @scale.to_i
-    data   = image.resize(width, height).save(tfile.path)
+
+    image.resize(width, height).save(tfile.path)
 
     @image_label.image = tfile.path
   end
@@ -66,31 +70,33 @@ class Circule::GUI
     @root ||= root {
       title 'Circule GUI'
 
-      frame {
-        entry   {                   text <=> [self, :hex]     }
-
-        label   {                   text            'bit0:'   }
-        spinbox { from   0; to 255; text <=> [self, :bit0]    }
-        label   {                   text            'step:'   }
-        spinbox { from   4; to  64; text <=> [self, :step]    }
-        label   {                   text            'bitn:'   }
-        spinbox { from   0; to 255; text <=> [self, :bitn]    }
-        label   {                   text            'canvas:' }
-        spinbox { from  24; to  96; text <=> [self, :canvas]  }
-        label   {                   text            'ox:'     }
-        spinbox { from -96; to  96; text <=> [self, :ox]      }
-        label   {                   text            'oy:'     }
-        spinbox { from -96; to  96; text <=> [self, :oy]      }
-        label   {                   text            'scale:'  }
-        spinbox { from   1; to  24; text <=> [self, :scale]   }
+      scrollbar_frame {
+        xscrollbar false
+
+        entry   {                   text <=> [self, :hex]     ; grid row:  1, column: 1, column_span: 2, column_weight: 1 }
+
+        label   {                   text            'bit0:'   ; grid row:  2, column: 1, column_span: 1, column_weight: 0 }
+        spinbox { from   0; to 255; text <=> [self, :bit0]    ; grid row:  2, column: 2, column_span: 1, column_weight: 1 }
+        label   {                   text            'step:'   ; grid row:  3, column: 1, column_span: 1, column_weight: 0 }
+        spinbox { from   4; to  64; text <=> [self, :step]    ; grid row:  3, column: 2, column_span: 1, column_weight: 1 }
+        label   {                   text            'bitn:'   ; grid row:  4, column: 1, column_span: 1, column_weight: 0 }
+        spinbox { from   0; to 255; text <=> [self, :bitn]    ; grid row:  4, column: 2, column_span: 1, column_weight: 1 }
+        label   {                   text            'canvas:' ; grid row:  5, column: 1, column_span: 1, column_weight: 0 }
+        spinbox { from  24; to  96; text <=> [self, :canvas]  ; grid row:  5, column: 2, column_span: 1, column_weight: 1 }
+        label   {                   text            'ox:'     ; grid row:  6, column: 1, column_span: 1, column_weight: 0 }
+        spinbox { from -96; to  96; text <=> [self, :ox]      ; grid row:  6, column: 2, column_span: 1, column_weight: 1 }
+        label   {                   text            'oy:'     ; grid row:  7, column: 1, column_span: 1, column_weight: 0 }
+        spinbox { from -96; to  96; text <=> [self, :oy]      ; grid row:  7, column: 2, column_span: 1, column_weight: 1 }
+        label   {                   text            'scale:'  ; grid row:  8, column: 1, column_span: 1, column_weight: 0 }
+        spinbox { from   1; to  24; text <=> [self, :scale]   ; grid row:  8, column: 2, column_span: 1, column_weight: 1 }
 
         frame {
-          @image_label = label { anchor 'center' }
+          @image_label = label { anchor 'center' }            ; grid row:  9, column: 1, column_span: 2, column_weight: 1
         }
 
-        button { text 'Open'; command { open    } }
-        button { text 'Save'; command { save    } }
-        button { text 'Exit'; command { exit(0) } }
+        button { text 'Open'; command { open    }             ; grid row: 10, column: 1, column_span: 2, column_weight: 1 }
+        button { text 'Save'; command { save    }             ; grid row: 11, column: 1, column_span: 2, column_weight: 1 }
+        button { text 'Exit'; command { exit(0) }             ; grid row: 12, column: 1, column_span: 2, column_weight: 1 }
       }
     }
   end

data/lib/circule/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Circule
-  VERSION = '0.1.0'
+  VERSION = '0.1.4'
 end

data/lib/circule.rb

@@ -7,6 +7,7 @@ require 'net/http'
 require 'chunky_png'
 require 'securerandom'
 
+# Convert a hash to an icon.
 class Circule
   class Error < StandardError; end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circule
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Frank J. Cameron
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-30 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - fjc@fastmail.net
 executables:
@@ -41,6 +41,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- circule-demo.mp4
 - circule.gemspec
 - exe/circule
 - lib/circule.rb
@@ -51,7 +52,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://gitlab.com/fjc/circule
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -59,15 +60,15 @@ 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: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.2.5
+signing_key: 
 specification_version: 4
-summary: ''
+summary: Generate an icon of overlapping circles derived from a hash.
 test_files: []