vissen-output 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee97aa25edd367c68a4f113fac72270890711d5859eb61bec40a71470753fb8e
-  data.tar.gz: c1069056b86a4f7d62ab4e5d5602bcf5c8131d684e8dc9631955f2582d516e3a
+  metadata.gz: e1f284f6ad345d37cb5c25d694d590c209272e00f385abcf6fa334c960adf3d0
+  data.tar.gz: ec8fd6ce58c0f326ec4abf696abf9a385a06e6df038015d37abac3bea7dc0b2a
 SHA512:
-  metadata.gz: 7475b3b4f78d4fd8f0a656d9dc3e45ade1af5a06e1596df9faa5de8eaa508c3489001b714aaf8f509f9b09d9416ecd99c95ac8682aa17f4cc5ced85003299ad1
-  data.tar.gz: 9c552a4b52af3646f6459116e3dda5a297c147886f90c261bb85448b1c978eda53155f68028d186af7b7fa0a77c428e4c9e598ae2ae2ebfb67069e46f2ba54ab
+  metadata.gz: 47c9ba55e30155f5167bfe12b6eac0120924bf8e30e5097ce30d548a7ef613c3c9c4d4844525b7a23971a0b2c67c207a536dedf8c35bf3b43ad085ba3a171658
+  data.tar.gz: 61eddc34c45113076783b59676262d1cbf28be8b6ceaaed7446d8802cf95cd8bc08ed2a604e1602a7d37f445574367d52fb8d8d4f4ff07c6b4559981cf93aa30

data/CHANGELOG.md

@@ -5,6 +5,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Introduced the #center method in contexts to easily find the x and y coordinates of the center point.
+- The utility method Context#each_polar_offset.
+- Palette#discretize creates a new discrete copy of a palette.
+
+### Changed
+- Context#distance_squared now yields each distance to a block instead of writing to an array.
+- Changed the name of Context#distance_squared to Context#each_distance_squared.  The old method is still available as an alias.
+- Vixels no longer truncate values (for performance reasons).
+
 ## [0.6.1] - 2018-04-20
 ### Changed
 - Improved, more descriptive comments.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vissen-output (0.6.1)
+    vissen-output (0.6.2.pre)
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +16,7 @@ GEM
     powerpack (0.1.1)
     rainbow (3.0.0)
     rake (10.5.0)
+    redcarpet (3.4.0)
     rubocop (0.55.0)
       parallel (~> 1.10)
       parser (>= 2.5)
@@ -30,6 +31,7 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     unicode-display_width (1.3.0)
+    yard (0.9.12)
 
 PLATFORMS
   ruby
@@ -38,9 +40,11 @@ DEPENDENCIES
   bundler (~> 1.16)
   minitest (~> 5.0)
   rake (~> 10.0)
+  redcarpet (~> 3.4)
   rubocop (~> 0.52)
   simplecov (~> 0.16)
   vissen-output!
+  yard (~> 0.9)
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,7 +1,9 @@
-# Vissen::Output
+# 🥀 Vissen Output
 
+[![Gem Version](https://badge.fury.io/rb/vissen-output.svg)](https://badge.fury.io/rb/vissen-output)
 [![Build Status](https://travis-ci.org/midi-visualizer/vissen-output.svg?branch=master)](https://travis-ci.org/midi-visualizer/vissen-output)
 [![Inline docs](http://inch-ci.org/github/midi-visualizer/vissen-output.svg?branch=master)](http://inch-ci.org/github/midi-visualizer/vissen-output)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/vissen-output/)
 
 The Vissen Output library implements the objects used by the Vissen Engine to talk to the various sinks.
 
@@ -23,7 +25,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+include Vissen::Output
+
+# First we create a grid shaped context with 64 points.
+context = Context::Grid.new 8, 8
+
+# We then create a vixel stack with a single layer.
+stack = VixelStack.new context, 1
+
+# We go through each vixel in the layer and randomize its
+# palette value (p). We also set the layer palette to
+# palette number 1.
+stack.layers[0].tap do |layer|
+    layer.palette = 1
+    layer.each do |vixel|
+        vixel.i = 1.0
+        vixel.p = rand
+    end
+end
+
+# Finally we allocate a pixel buffer and render to it.
+pixel_buffer = stack.pixel_buffer
+stack.render pixel_buffer
+
+```
+
+Please see the [documentation](http://www.rubydoc.info/gems/vissen-output/) for more details.
 
 ## Development
 

data/Rakefile

@@ -3,6 +3,7 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rubocop/rake_task'
+require 'yard'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
@@ -10,8 +11,14 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-RuboCop::RakeTask.new(:rubocop) do |t|
-  t.options = ['-a']
+RuboCop::RakeTask.new(:rubocop)
+
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.stats_options = %w[--list-undoc]
+  t.files = ['lib/**/*.rb', '-', 'CHANGELOG.md']
 end
 
-task default: :test
+desc 'Generate Ruby documentation'
+task doc: %w[yard]
+
+task default: %w[test rubocop:auto_correct]

data/lib/vissen/output/context.rb

@@ -71,6 +71,14 @@ module Vissen
         Array.new(point_count, &block)
       end
 
+      # Uses the width and height och the context to calculate the x and y
+      # coordinates of the center point.
+      #
+      # @return [Array<Float>] the center coordinates.
+      def center
+        [width / 2.0, height / 2.0]
+      end
+
       # Iterates over the context points. The index of the the point is passed
       # to the given block.
       #
@@ -113,20 +121,43 @@ module Vissen
         index
       end
 
-      # This utility method traverses the given target array and calculates for
-      # each corresponding grid point index the squared distance between the
-      # point and the given coordinate.
+      # This utility method calculates the squared distance between each point
+      # and the given coordinate. The squared distance is then yielded to the
+      # given block.
       #
       # @param  x [Numeric] the x coordinate to calculate distances from.
       # @param  y [Numeric] the y coordinate to calculate distances from.
-      # @param  target [Array<Float>] the target array to populate with
-      #   distances.
-      def distance_squared(x, y, target)
-        target.each_with_index do |_, i|
-          x_i, y_i = position i
+      # @return [Enumerable] if no block is given.
+      def each_distance_squared(x, y)
+        return to_enum(__callee__, x, y) unless block_given?
+
+        each_position do |_, x_i, y_i|
+          yield (x_i - x)**2 + (y_i - y)**2
+        end
+      end
+
+      alias distance_squared each_distance_squared
+
+      # This method calculates the distance and angle to each point and the
+      # given coordinate. The distance and angle are then yielded to the given
+      # block.
+      #
+      # @param  x [Numeric] the x coordinate to calculate angle and distance
+      #   from.
+      # @param  y [Numeric] the y coordinate to calculate angle and distance
+      #   from.
+      # @return [Enumerable] if no block is given.
+      def each_polar_offset(x, y)
+        return to_enum(__callee__, x, y) unless block_given?
+
+        each_position do |_, x_i, y_i|
           dx = x_i - x
           dy = y_i - y
-          target[i] = (dx * dx) + (dy * dy)
+
+          distance = Math.sqrt(dx**2 + dy**2)
+          angle    = Math.atan2 dy, dx
+
+          yield distance, angle
         end
       end
     end

data/lib/vissen/output/filter/quantizer.rb

@@ -24,8 +24,7 @@ module Vissen
           to   = if range.exclude_end?
                    raise ArgumentError if range.end.is_a?(Float)
                    range.end - 1
-                 else
-                   range.end
+                 else range.end
                  end
 
           design_function from, to, steps

data/lib/vissen/output/palette.rb

@@ -52,6 +52,12 @@ module Vissen
         super
       end
 
+      # @param  steps [Fixnum] the number of discrete colors in the new palette.
+      # @return [Palette] a new, discrete palette.
+      def discretize(steps)
+        self.class.new(*@colors, steps: steps, label: @label)
+      end
+
       # Discretize the palette into the given number of values. Palettes defined
       # with a step count are sampled as if they where continuous.
       #
@@ -75,11 +81,12 @@ module Vissen
       private
 
       def define_discrete_accessor(steps)
-        @palette = to_a steps
+        @palette = to_a(steps).freeze
+        last_color_index = @palette.length - 1
         define_singleton_method :[] do |index|
-          index = if index >= 1.0 then @palette.length - 1
+          index = if index >= 1.0 then last_color_index
                   elsif index < 0.0 then 0
-                  else (index * (@palette.length - 1)).floor
+                  else (index * last_color_index).floor
                   end
 
           @palette[index]

data/lib/vissen/output/version.rb

@@ -3,6 +3,6 @@
 module Vissen
   module Output
     # The Vissen Output library version number.
-    VERSION = '0.6.1'
+    VERSION = '0.7.0'
   end
 end

data/lib/vissen/output/vixel.rb

@@ -9,10 +9,10 @@ module Vissen
     # TODO: How do we want the vixel to saturate? When written or when read?
     class Vixel
       # @return [Float] the vixel intensity.
-      attr_reader :i
+      attr_accessor :i
 
       # @return [Float] the vixel palette position.
-      attr_reader :p
+      attr_accessor :p
 
       # @param  i [Numeric] the vixel intensity.
       # @param  p [Numeric] the vixel palette position.
@@ -30,35 +30,10 @@ module Vissen
         false
       end
 
-      # @param  value [Numeric] the new intensity value.
-      # @return [Float] the truncated intensity value.
-      def i=(value)
-        @i = self.class.truncate value
-      end
-
-      # @param  value [Numeric] the new palette position.
-      # @return [Float] the truncated palette position.
-      def p=(value)
-        @p = self.class.truncate value
-      end
-
       # @return [String] a string representation of the vixel.
       def inspect
         format '(%.1f, %.1f)', @i, @p
       end
-
-      class << self
-        # Makes sure n is in the range 0..1.
-        #
-        # @param  n [Numeric] the value to truncate.
-        # @return [Float] n truncated to fit within the range 0..1.
-        def truncate(n)
-          if n <= 0    then 0.0
-          elsif n >= 1 then 1.0
-          else              n
-          end
-        end
-      end
     end
   end
 end

data/vissen-output.gemspec

@@ -26,6 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
   spec.add_development_dependency 'rubocop', '~> 0.52'
   spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vissen-output
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Sebastian Lindberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2018-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: The output module implements all the objects and facilities used to talk
   to vissen sinks.
 email: