multi_movingsign 0.0.1

data/lib/multi_movingsign/settings.rb

@@ -0,0 +1,55 @@
+require 'yaml'
+require 'hashie'
+require 'multi_movingsign/sign'
+
+module MultiMovingsign
+  # Settings wrapper (reads/saves from/to YAML file via {load} / {#dump})
+  class Settings
+    attr_accessor :mash
+
+    # Constructs a new {Settings} instance from settings saves in the specified YAML file
+    def self.load(path)
+      if File.exists? path
+        self.new YAML.load(File.read(path))
+      else
+        self.new({})
+      end
+    end
+
+    def initialize(hash = {})
+      self.mash = Hashie::Mash.new hash
+    end
+
+    # Returns an array of the configured {Sign}s
+    def signs
+      self.mash.signs ||= []
+
+      self.mash.signs.map { |hash| Sign.load(hash) }
+    end
+
+    # +true+ if any signs are configured
+    def signs?
+      ! self.signs.empty?
+    end
+
+    # Sets the list of conifgured {Sign}s via an array of serial port paths
+    #
+    # @example
+    #   settings.sign_paths = ['/dev/ttyUSB0', '/dev/ttyUSB1']
+    def sign_paths=(paths)
+      self.mash.signs = paths.map { |path| {'path' => path} }
+    end
+
+    # Serializes (dumps) the settings into the specified YAML file
+    def dump(path)
+      File.open(path, 'w') do |f|
+        f.write(self.mash.to_hash.to_yaml)
+      end
+    end
+
+    # Default path for the settings YAML file
+    def self.default_settings_path
+      File.join(ENV['HOME'], '.multi_movingsign.yml')
+    end
+  end
+end

data/lib/multi_movingsign/sign.rb

@@ -0,0 +1,37 @@
+require 'movingsign_api'
+require 'multi_movingsign/sign'
+
+module MultiMovingsign
+  # Represents an individual Movingsign LED sign being driven
+  class Sign
+    attr_accessor :path
+
+    def initialize(path)
+      self.path = path
+    end
+
+    def self.load(hash)
+      path = hash['path'] || (raise InvalidInputError, "path key not specified")
+
+      self.new path
+    end
+
+    def show_text(text, options = {})
+      sign.show_text text, options
+    end
+
+    def set_sound(on)
+      sign.set_sound on
+    end
+
+    def to_hash
+      {'path' => self.path}
+    end
+
+    private
+
+    def sign
+      MovingsignApi::Sign.new self.path
+    end
+  end
+end

data/lib/multi_movingsign/signs.rb

@@ -0,0 +1,39 @@
+require 'multi_movingsign/sign'
+
+module MultiMovingsign
+  # Represents a collection of {Sign}s that you want to drive in unison
+  class Signs
+    attr_accessor :signs
+
+    # @param options [Array<Sign>] an array of {Sign} instances
+    def initialize(options)
+      if options.kind_of?(Array) && options.all? { |v| v.kind_of?(Sign) }
+        self.signs = options
+      else
+        raise InvalidInputError, "Invalid Signs#new options"
+      end
+    end
+
+    # Sends/show the specified page solution on the signs
+    def show_page_solution(solution)
+      threads = []
+      solution['signs'].each_with_index do |hash, i|
+        threads << Thread.new do
+          # Prepend "\xFDB" to set color to HIGH RED
+          # .gsub("\n", "\x7F") - replace new lines with the sign specific newline character
+          text = "\xFDB" + hash['content'].gsub("\n", "\x7F")
+          self.signs[i].show_text text, :display_pause => 3
+        end
+      end
+      threads.each { |t| t.join }
+    end
+
+    def show_identity
+      self.signs.each_with_index { |s, i| s.show_text "#{i} #{s.path}" }
+    end
+
+    def length
+      self.signs.length
+    end
+  end
+end

data/lib/multi_movingsign/testrc_loader.rb

@@ -0,0 +1,17 @@
+require 'yaml'
+
+# Helper that reads a test YAML file and loads/executes the appropriate scripts
+# {file:spec/noop_movingsign_sign.yml}
+class TestRCLoader
+  def self.load(testrc_path)
+    base_dir = File.expand_path(File.dirname testrc_path)
+    testrc_hash = YAML::load(File.read(testrc_path))
+
+    script_path = testrc_hash['script']
+    script_path = File.join(base_dir, script_path) if Pathname.new(script_path).relative?
+
+    parameters = testrc_hash['parameters'] || {}
+
+    Kernel.eval(File.read(script_path), binding, script_path)
+  end
+end

data/lib/multi_movingsign/version.rb

@@ -0,0 +1,3 @@
+module MultiMovingsign
+  VERSION = "0.0.1"
+end

data/multi_movingsign.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multi_movingsign/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multi_movingsign"
+  spec.version       = MultiMovingsign::VERSION
+  spec.authors       = ["Eric Webb"]
+  spec.email         = ["eric@collectivegenius.net"]
+  spec.description   = "Code that drives multiple MovingSign display boards in unison."
+  spec.summary       = "Code that drives multiple MovingSign display boards in unison."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+    .reject { |path| path.match /\A\.idea\//  }     # Ignore .idea/ IntelliJ project directory
+    .reject { |path| path.match /\A[^\/]+\.iml/ }   # Ignore *.iml IntelliJ module file
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "wwtd"
+
+  spec.add_runtime_dependency 'thor', '~> 0.18.1'
+  spec.add_runtime_dependency 'hashie', '~> 2.0'
+  spec.add_runtime_dependency 'movingsign_api', '0.0.2'
+end

data/spec/cli_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+require 'tempfile'
+require 'timeout'
+
+describe MultiMovingsign::Cli do
+  let(:temp_settings_file) { File.join(Dir.mktmpdir('test-settings-'), 'test-settings.yml') }
+  let(:multi_movingsign_exe) { Gem.bin_path('multi_movingsign', 'multi_movingsign') }
+
+  # Testing magic, @see TestRCLoader and {file:spec/noop_movingsign_sign.rb}
+  let(:testrc_noop) { "spec/noop_movingsign_sign.yml" }
+  let(:testrc_results) { Hashie::Mash.new YAML::load(File.read('testrc.yml')) }
+
+  let(:setup_command_results) { execute("#{multi_movingsign_exe} setup --rc #{temp_settings_file} --signs /dev/ttyUSB0") }
+
+  describe "'setup' command" do
+    it "No Options" do
+      expect(execute("#{multi_movingsign_exe} setup")).to be_success
+    end
+
+    describe "--signs /dev/ttyUSB0" do
+      let (:execution_results) { execute("#{multi_movingsign_exe} setup --rc #{temp_settings_file} --signs /dev/ttyUSB0") }
+      let (:hash) { YAML.load(File.read(temp_settings_file)) }
+
+      before(:each) do
+        execution_results
+      end
+
+      it "Succeeds" do
+        expect(execution_results).to be_success
+      end
+
+      it "Settings File Exists" do
+        expect(File.exists? temp_settings_file).to be_true
+      end
+
+      it "Settings File Contains ttyUSB0" do
+        expect(File.read(temp_settings_file)).to include 'ttyUSB0'
+      end
+    end
+  end
+
+  describe "'settings' command" do
+    let (:settings_command_results) { execute("#{multi_movingsign_exe} settings --rc #{temp_settings_file}") }
+
+    describe "Without Setup" do
+      before(:each) do
+        settings_command_results
+      end
+
+      it "Succeeds" do
+        expect(settings_command_results).to be_success
+      end
+
+      it "Containts 'Signs (0)'" do
+        expect(settings_command_results.stdout).to include 'Signs (0)'
+      end
+    end
+
+    describe "With Setup" do
+      before(:each) do
+        setup_command_results
+        settings_command_results
+      end
+
+      it "Succeeds" do
+        expect(settings_command_results).to be_success
+      end
+
+      it "Containts 'ttyUSB0'" do
+        expect(settings_command_results.stdout).to include 'ttyUSB0'
+      end
+
+      it "Containts 'Signs (1)'" do
+        expect(settings_command_results.stdout).to include 'Signs (1)'
+      end
+    end
+  end
+
+  describe "'show-identity' command" do
+    let (:show_identity_command_results) { execute("#{multi_movingsign_exe} show-identity --rc #{temp_settings_file} --testrc #{testrc_noop}") }
+
+    before(:each) do
+      setup_command_results
+
+      double_movingsign_sign
+      show_identity_command_results
+    end
+
+    it "Succeeds" do
+      expect_command_success show_identity_command_results
+    end
+
+    it "Signs Calls == 1" do
+      expect(testrc_results.calls.length).to eq 1
+    end
+  end
+
+  describe "'server' subcommand" do
+    let (:server_configuration_directory) { Dir.mktmpdir "multi_movingsign_server-" }
+    let (:server_thread) { thread = Thread.new { execute("#{multi_movingsign_exe} server start --rc #{temp_settings_file} --serverrc #{server_configuration_directory} --testrc #{testrc_noop}") }; sleep 1; thread }
+
+    before(:each) do
+      setup_command_results
+    end
+
+    describe "'start' command" do
+      before(:each) do
+        double_movingsign_sign
+        server_thread
+      end
+
+      after(:each) do
+        server_thread.kill
+        server_thread.join
+      end
+
+      it "Is Alive?" do
+        expect(server_thread).to be_alive
+      end
+
+      it "Creates PID File" do
+        expect(File.exists? File.join(server_configuration_directory, 'server.lock')).to be_true
+      end
+
+      it "Creates SOCK File" do
+        expect(File.exists? File.join(server_configuration_directory, 'server.sock')).to be_true
+      end
+    end
+
+    describe "'stop' command" do
+      let (:server_stop_results) { execute "#{multi_movingsign_exe} server stop --rc #{temp_settings_file} --serverrc #{server_configuration_directory}" }
+
+      before(:each) do
+        double_movingsign_sign
+        server_thread
+
+        timeout(60) { server_stop_results }
+      end
+
+      after(:each) do
+        server_thread.kill
+        server_thread.join
+      end
+
+      it "Shuts Down Server" do
+        sleep 3
+
+        expect(server_thread).to_not be_alive
+        expect(server_stop_results).to be_success
+      end
+    end
+
+    pending "'add-page' command"
+    pending "'delete-page' command"
+    pending "'alert' command"
+  end
+
+  #it "show-page command"
+  #it "show-page succeeds"
+  #it "show-page sends show_text on each display"
+  #it "server"
+  #multi_movingsign server add-page --name=NAME --page=PAGE  # Adds a page to the server rotation
+  #multi_movingsign server alert --page=PAGE                 # Sends a page to display as an alert
+  #multi_movingsign server delete-page --name=NAME           # Deletes a page to the server rotation
+  #multi_movingsign server help [COMMAND]                    # Describe subcommands or one specific subcommand
+end

data/spec/noop_movingsign_sign.rb

@@ -0,0 +1,47 @@
+#
+# Loaded by noop_movingsign_sign.yml
+#
+# This script makes all MovingsignApi::Sign methods a noop, allowing you to run/test/validate the CLI
+# without having physical LED signs plugged in.
+#
+require 'movingsign_api/sign'
+
+klass = Class.new do
+  def double_movingsign_sign
+    MovingsignApi::Sign.class_exec do
+      @@mutex = Mutex.new
+
+      class << self
+        attr_accessor :calls
+      end
+
+      (MovingsignApi::Sign.public_instance_methods.to_a - Object.public_instance_methods.to_a - [:device_path]).each do |method|
+        define_method(method) do |*args|
+          @@mutex.synchronize do
+            # sanitize arguments (since they contain invalid characters)
+            sanitized_args = []
+            args.each do |arg|
+              if arg.kind_of? String
+                sanitized_args << arg.encode("ASCII", :invalid => :replace, :undef => :replace, :replace => "?")
+              end
+            end
+
+            self.calls << [self.device_path, method, sanitized_args]
+
+            File.open('testrc.yml', 'w') do |f|
+              f.write({'calls' => self.calls}.to_yaml)
+            end
+          end
+        end
+      end
+
+      def calls
+        self.class.calls
+      end
+    end
+
+    MovingsignApi::Sign.calls = []
+  end
+end
+
+klass.new.double_movingsign_sign

data/spec/noop_movingsign_sign.yml

@@ -0,0 +1,7 @@
+# Configuration file for testing
+#
+# Sets up MovingsignApi::Sign to be no-ops...enabling testings + validation without LED Signs being attached
+
+---
+script: noop_movingsign_sign.rb
+parameters:

data/spec/page_renderer/example_1/1.yml

@@ -0,0 +1,16 @@
+lines:  13
+signs:
+- content: |-
+    Top Drinkers
+    1. mikey
+    1. 445 pints
+    2. capn
+    2. 183 pints
+    3. eric
+    3. 122 pints
+    4. whitey
+    4. 114 pints
+    5. justin
+    5. 110 pints
+    6. scarfjerk
+    6. 109 pints

data/spec/page_renderer/example_1/2.yml

@@ -0,0 +1,28 @@
+lines: 12
+signs:
+- content: |-
+    Top Drinkers
+    Top Drinkers
+    Top Drinkers
+    Top Drinkers
+    Top Drinkers
+    Top Drinkers
+    Top Drinkers
+    Top Drinkers
+    Top Drinkers
+    Top Drinkers
+    Top Drinkers
+    Top Drinkers
+- content: |-
+    1. mikey
+    1. 445 pints
+    2. capn
+    2. 183 pints
+    3. eric
+    3. 122 pints
+    4. whitey
+    4. 114 pints
+    5. justin
+    5. 110 pints
+    6. scarfjerk
+    6. 109 pints