wtf_chord 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42f6e0b2d54785364d40dfc28d48ac718a62feb3
-  data.tar.gz: 4747da8acf163bdeea61e0ab1902f6bf6d812445
+  metadata.gz: 63e6deb4fcd84c93ca4b45c777e8510bc721cfb8
+  data.tar.gz: c8a5cd9fa823393c02b09670cb59094e48685fad
 SHA512:
-  metadata.gz: f34f794282e89a4f924c04bf74ea234b4e484bd95a4f78e583dae57e27133775a86fd8fa817928c702fadafedd31fa2a8805ce78c7e47ff56958afbaa75108a0
-  data.tar.gz: 6fdf726a6bb8e8f2ad2446b40347f28a2e47692944fc879ed35b80366650bc770eedfa6a9c29a6a846e74ada7a505a6ffc944e5cc0769c9574688fc153fd0339
+  metadata.gz: 82eb003ec0978911c7806e8b1d338ec495fcd63f72d26262baa075209f29b4854a0237c885887177e26e4d3b438909023e07ad5201152b873ea456266fb7d14e
+  data.tar.gz: d2f439cd8f2dc14886520b8a5f72f16cce4c7934e250742cc1e5c5a2e9a107a967d25e470992411cf3e2d730d2d7d5698baf64467eab0b61441b69e3e6805295

data/README.md

@@ -27,9 +27,31 @@ Or install it yourself as:
 
 ## CLI-tool usage
 
+    Usage: wtfchord [options] name
+
+    Finds fingerings of the requested chord.
+
+    v0.2.0
+
+    Options:
+        -h, --help                       Show command line help
+            --version                    Show help/version info
+        -n, --amount N                   Amount of fingering variants to output.
+                                         (default: 3)
+        -o, --output FORMAT              Output format.
+                                         (default: default)
+            --log-level LEVEL            Set the logging level
+                                         (debug|info|warn|error|fatal)
+                                         (Default: info)
+
+    Arguments:
+
+        name
+            Chord name to find.
+
 For example, to print two fingering variants of the `Dm` chord, just run:
 
-    $ wtfchord Dm 2
+    $ wtfchord Dm -n 2
 
 And you'll get the visual presentation of chords' fingerings:
 
@@ -55,6 +77,19 @@ And you'll get the visual presentation of chords' fingerings:
      ––––––––––––––––––
          D  A  D  F  A
 
+You can get simpler output, using the `--output` option:
+
+    $ wtfchord Dm -n 10 --output=simple
+    Dm (D - F - A)
+
+    [ × × 0 2 3 1 ]
+    [ × 5 3 2 3 1 ]
+    [ × 5 3 2 3 5 ]
+    [ × 5 3 7 3 5 ]
+    [ × 5 7 7 6 5 ]
+    [ 10 8 7 7 6 10 ]
+    [ 10 8 7 7 10 10 ]
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec wtf_chord` to use the gem in this directory, ignoring other installed copies of this gem.

data/exe/wtfchord

@@ -3,9 +3,7 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'rubygems' unless Object.const_defined?(:Gem)
-require "wtf_chord"
+require 'wtf_chord'
+require 'wtf_chord/cli'
 
-chord = WTFChord.chord(ARGV[0])
-
-puts chord.inspect, nil
-chord.draw_fingerings(ARGV[1]&.to_i || 3)
+WTFChord::CLI.go!

data/lib/wtf_chord/chord.rb

@@ -20,13 +20,14 @@ module WTFChord
 
     def fingerings(limit = 3)
       list = []
+
       (0..MAX_FRET).each do |from_fret|
         f = get_fingering(from_fret)
         next if list.include?(f)
         list << f if all_notes?(f.used_strings)
       end
 
-      list.sort_by!(&:complexity)[0...limit].sort_by!(&:min_fret)
+      sort_fingerings(list, limit)
     end
 
     def get_fingering(from_fret = 0)
@@ -59,8 +60,9 @@ module WTFChord
       string && string.note != @notes[i]
     end
 
-    def draw_fingerings(limit = 3)
-      puts (fingerings(limit).map(&:draw) * "\n\n")
+    def sort_fingerings(list, limit)
+      list.sort_by!(&:complexity)
+      list[0...limit].sort_by!(&:min_fret)
     end
   end
 end

data/lib/wtf_chord/cli.rb

@@ -0,0 +1,42 @@
+require 'optparse'
+require 'methadone'
+
+module WTFChord
+  class CLI
+    include Methadone::Main
+    include Methadone::CLILogging
+
+    main do |name|
+      chord      = WTFChord.chord(name)
+      fingerings = chord.fingerings(options['amount'])
+      formatter  = WTFChord::Formatter.new(options['output'])
+
+      debug { "Output using formatter: #{formatter.formatter.to_s}\n" }
+
+      puts chord.inspect, nil
+      formatter.(*fingerings)
+    end
+
+    version VERSION
+
+    description "Finds fingerings of the requested chord."
+
+
+    ##
+    # Arguments
+    #
+    arg :name, "Chord name to find."
+
+
+    ##
+    # Options
+    #
+    options['amount'] = 3
+    options['output'] = 'default'
+
+    on "-n N", "--amount N", Integer, "Amount of fingering variants to output."
+    on "-o FORMAT", "--output FORMAT", "Output format."
+
+    use_log_level_option
+  end
+end

data/lib/wtf_chord/fingering.rb

@@ -1,6 +1,6 @@
 require 'wtf_chord/fretboard'
 require 'wtf_chord/complexity_counter'
-require 'wtf_chord/drawer'
+require 'wtf_chord/formatter'
 
 module WTFChord
   class Fingering < Fretboard
@@ -23,7 +23,7 @@ module WTFChord
     end
 
     def draw
-      Drawer.new(self).draw
+      Formatter.new(:default).call(self)
     end
 
     def set_fingers(fingers)

data/lib/wtf_chord/formatter.rb

@@ -0,0 +1,32 @@
+require 'wtf_chord/formatters/base'
+
+module WTFChord
+  class Formatter
+    def initialize(name)
+      @name = name
+      require_formatter! unless formatter?
+    end
+
+    def call(*fingerings)
+      puts (fingerings.map(&formatter) * formatter.separator)
+    end
+
+    alias :[] :call
+
+    def formatter
+      WTFChord::Formatters.const_get(formatter_name)
+    end
+
+    def formatter?
+      WTFChord::Formatters.const_defined?(formatter_name)
+    end
+
+    def formatter_name
+      @formatter_name ||= @name.gsub(/(?:^|_)([a-z\d]*)/i) { "#{$1.capitalize}" }.to_s.freeze
+    end
+
+    def require_formatter!
+      require "wtf_chord/formatters/#{@name}"
+    end
+  end
+end

data/lib/wtf_chord/formatters/base.rb

@@ -0,0 +1,37 @@
+require 'forwardable'
+
+module WTFChord
+  module Formatters
+    class Base
+      FRETS = 6
+
+      extend Forwardable
+      def_delegators :@fret, :strings
+
+      def self.separator
+        "\n".freeze
+      end
+
+      def self.to_proc
+        proc { |fret| new(fret).draw }
+      end
+
+      def initialize(fret)
+        @fret = fret
+      end
+
+      def draw
+      end
+
+      protected
+
+      def min_fret
+        @min_fret = begin
+          frets = strings.map(&:fret).tap(&:compact!)
+          _min = frets.min.to_i || 1
+          _min > 2 ? _min : 1
+        end
+      end
+    end
+  end
+end

data/lib/wtf_chord/formatters/default.rb

@@ -0,0 +1,64 @@
+module WTFChord
+  module Formatters
+    class Default < Base
+      OPEN  = "|".freeze
+      HORIZ = "–".freeze
+      SPACE = "  ".freeze
+      BULL  = "\u2022".freeze
+      LATIN = %w(0 I II III IV V VI VII VIII IX X XII XIII).freeze
+      NEWLINE = "\n".freeze
+
+      def self.separator
+        "\n\n".freeze
+      end
+
+      def draw
+        [
+          "[ #{head} ]#{capo}",
+          " #{border}",
+          *fret_rows,
+          " #{border}",
+          "  #{string_keys}"
+        ] * NEWLINE
+      end
+
+      private
+
+      def head
+        @fret.fingers * SPACE
+      end
+
+      def capo
+        "  (capo #{to_latin @fret.capo})" if @fret.capo > 0
+      end
+
+      def border
+        @border ||= HORIZ * 3 * strings.length
+      end
+
+      def string_rows
+        strings.map { |string| draw_string(string.fret) }
+      end
+
+      def fret_rows
+        string_rows.transpose.map! { |row| "  #{row * SPACE}  " }.tap do |rows|
+          rows[0] << "  #{to_latin min_fret}" if min_fret > 1
+        end
+      end
+
+      def string_keys
+        strings.map { |s| s.dead? ? SPACE : "%-2s" % s.key } * " "
+      end
+
+      def to_latin(num)
+        LATIN[num]
+      end
+
+      def draw_string(fret)
+        Array.new(FRETS, OPEN).tap do |rows|
+          rows[(fret - min_fret.pred).pred] = BULL if fret.to_i > 0
+        end
+      end
+    end
+  end
+end

data/lib/wtf_chord/formatters/simple.rb

@@ -0,0 +1,9 @@
+module WTFChord
+  module Formatters
+    class Simple < Base
+      def draw
+        "[ #{@fret.fingers * " "} ]"
+      end
+    end
+  end
+end

data/lib/wtf_chord/version.rb

@@ -1,3 +1,3 @@
 module WTFChord
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/wtf_chord.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "methadone"
+
   spec.add_development_dependency "bundler", ">= 1.11", "< 2"
   spec.add_development_dependency "rake", ">= 10.0", "< 12"
   spec.add_development_dependency "rspec", ">= 3.0", "< 4"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: wtf_chord
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Anton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-04-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -90,9 +104,13 @@ files:
 - lib/wtf_chord.rb
 - lib/wtf_chord.yml
 - lib/wtf_chord/chord.rb
+- lib/wtf_chord/cli.rb
 - lib/wtf_chord/complexity_counter.rb
-- lib/wtf_chord/drawer.rb
 - lib/wtf_chord/fingering.rb
+- lib/wtf_chord/formatter.rb
+- lib/wtf_chord/formatters/base.rb
+- lib/wtf_chord/formatters/default.rb
+- lib/wtf_chord/formatters/simple.rb
 - lib/wtf_chord/fretboard.rb
 - lib/wtf_chord/guitar_string.rb
 - lib/wtf_chord/note.rb

data/lib/wtf_chord/drawer.rb

@@ -1,79 +0,0 @@
-require 'forwardable'
-
-module WTFChord
-  class Drawer
-    FRETS = 6
-    OPEN  = "|".freeze
-    HORIZ = "–".freeze
-    SPACE = "  ".freeze
-    BULL  = "\u2022".freeze
-    LATIN = %w(0 I II III IV V VI VII VIII IX X XII XIII).freeze
-    NEWLINE = "\n".freeze
-
-    extend Forwardable
-    def_delegators :@fret, :strings
-
-    def initialize(fret, newline: nil)
-      @fret    = fret
-      @newline = newline || NEWLINE
-    end
-
-    def draw
-      [
-        "[ #{head} ]#{capo}",
-        " #{border}",
-        *fret_rows,
-        " #{border}",
-        "  #{string_keys}"
-      ] * @newline
-    end
-
-    protected
-
-    def min_fret
-      @min_fret = begin
-        frets = strings.map(&:fret).tap(&:compact!)
-        _min = frets.min.to_i || 1
-        _min > 2 ? _min : 1
-      end
-    end
-
-    def head
-      @fret.fingers * SPACE
-    end
-
-    def capo
-      "  (capo #{to_latin @fret.capo})" if @fret.capo > 0
-    end
-
-    def border
-      @border ||= HORIZ * 3 * strings.length
-    end
-
-    def string_rows
-      strings.map { |string| draw_string(string.fret) }
-    end
-
-    def fret_rows
-      string_rows.transpose.map! { |row| "  #{row * SPACE}  " }.tap do |rows|
-        rows[0] << "  #{to_latin min_fret}" if min_fret > 1
-      end
-    end
-
-    def string_keys
-      strings.map { |s| s.dead? ? SPACE : "%-2s" % s.key } * " "
-    end
-
-    private
-
-    def to_latin(num)
-      LATIN[num]
-    end
-
-    def draw_string(fret)
-      Array.new(FRETS, OPEN).tap do |rows|
-        rows[(fret - min_fret.pred).pred] = BULL if fret.to_i > 0
-      end
-    end
-  end
-end