belafonte 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a460418210e2ac70ea041d21767a9e07d66a2a59
-  data.tar.gz: 93cdbe5d558f4ad27929bcee53f9d3d4772a6a5a
+  metadata.gz: c8b79a1d44e0ead9355e7daf0091c3b93aac55fe
+  data.tar.gz: 7aa26f871377c9b8a0a110859500cb65f90f3c30
 SHA512:
-  metadata.gz: 9b4299b8461f277f49c286e15a0d161e84bf4028733b58e50359773b3ac0c1e2b3c9096d0763354de1ab400976f4d7385467085ac73be8725d464f0f27ef3855
-  data.tar.gz: b4b6256af663d2a3574ee1a7ece14e35af67832d0269078fe3c8cf1b61db7410baff18af87f9152d194480b6f81b532f20d412f4e63cbdabe399b9267bcaa157
+  metadata.gz: 7c5245a9afd12af2cb31ff4d5633afb8233db43ae1f02f9b0612f479b7869de05b144ba2321ce60faa35f12224a0bc88d3db15c52fdc77bb836fb99b918f85ee
+  data.tar.gz: 992f421cf4b967f43f0a7b6668f90cd333f55f0f948eb1acbbc9f2c200376c1cfe76936d588d6d0cba90455d6d9debefcb2e103f006f90b585a9bef9152c72ef

data/README.md

@@ -26,6 +26,16 @@ Or install it yourself as:
 
 ## Usage ##
 
+Belafonte can be used both to create traditional single-purpose applications
+(like `cat`, `ls`, `make`, etc), but it can also be used to create "command
+suite" applications (like `git`, `rails`, `heroku`, etc).
+
+### Traditional Applications ###
+
+As mentioned above, "traditional" applications are single-purpose utilities.
+They tend to do one thing, with the goal of doing that one thing exceptionally
+well.
+
 ```ruby
 require 'belafonte'
 
@@ -113,11 +123,19 @@ end
 exit MyApp.new(ARGV).execute!
 ```
 
-## Upcoming Features ##
+### Command Suite Applications ###
+
+Command suite applications (CSAs) are, in the simplest scenario, a collection
+of Traditional Applications that are collected under a wrapper to provide a
+uniform user interface.
+
+Belafonte supports this sort of application through mounting, which is very
+similar in spirit to, say, mounting one Rack application under another. The API is the same as the Traditional App API with two exceptions:
 
-So as to allow for "command suite" utilities, I'm planning to allow for the mounting of one application into another, a-la Rack, Sinatra, Grape, etc.
+* Use `mount App` to mount an application as a subcommand
+* Apps that mount other apps cannot have :unlimited args
 
-The API for this is unstable, and I need to figure out some business logic, but it should look something like this:
+Here's an example:
 
 ```ruby
 require 'belafonte'

data/lib/belafonte/app.rb

@@ -1,12 +1,12 @@
-require 'optparse'
 require 'belafonte/dsl'
-require 'belafonte/errors'
-require 'belafonte/help'
+require 'belafonte/rhythm'
 
 module Belafonte
   # An application container
   class App
     include Belafonte::DSL
+    include Belafonte::Helpers
+    include Belafonte::Rhythm
 
     attr_reader :argv, :stdin, :stdout, :stderr, :kernel
 
@@ -18,69 +18,5 @@ module Belafonte
       @kernel = kernel
       @parent = parent
     end
-
-    def execute!
-      (@parser = Parser.new(
-        switches: configured_switches,
-        options: configured_options,
-        commands: configured_subcommands,
-        arguments: configured_args,
-        argv: @argv
-      )).parsed.tap do |parsed|
-        @switches = parsed[:switches]
-        @options = parsed[:options]
-        @arguments = parsed[:args]
-        activate_help! if parsed[:help]
-      end
-
-      @command = arg(:command).shift if arg(:command)
-
-      unless dispatch || show_help || run_handle
-        stderr.puts "No handler for the provided command line"
-        return 1
-      end
-
-      0
-    end
-
-    private
-    def parent
-      @parent
-    end
-
-    def subcommand_instance(command)
-      command_class = configured_subcommands.
-        find {|subcommand| subcommand.info(:title) == command}
-
-      return nil unless command_class
-
-      command_class.new(arg(:command), stdin, stdout, stderr, kernel, self)
-    end
-
-    def dispatch
-      return false if @command.nil?
-      handler = subcommand_instance(@command)
-
-      unless handler
-        activate_help!
-        return false
-      end
-
-      handler.activate_help! if help_active?
-      handler.execute!
-      true
-    end
-
-    def show_help
-      return false unless help_active?
-      stdout.print Belafonte::Help.content_for(self)
-      true
-    end
-
-    def run_handle
-      return false unless respond_to?(:handle)
-      handle
-      true
-    end
   end
 end

data/lib/belafonte/argument_processor.rb

@@ -18,6 +18,9 @@ module Belafonte
       argv = @argv.clone
       arguments.each do |arg|
         values = arg.process(argv)
+        if arg.unlimited? && values.empty?
+          values.push('')
+        end
         processed[arg.name] = values
         argv.shift(values.length)
       end
@@ -34,7 +37,7 @@ module Belafonte
     end
 
     def validate_processed_args
-      raise Belafonte::Errors::TooFewArguments.new("You didn't provide enough arguments") if processed.values.any? {|arg| arg.empty?}
+      raise Belafonte::Errors::TooFewArguments.new("You didn't provide enough arguments") if processed.values.any? {|arg| arg.empty? && !arg.unlimited?}
     end
   end
 end

data/lib/belafonte/dsl/{class_methods.rb → definition.rb}

@@ -1,4 +1,3 @@
-require 'optparse'
 require 'belafonte/switch'
 require 'belafonte/option'
 require 'belafonte/argument'
@@ -7,7 +6,7 @@ require 'belafonte/errors'
 module Belafonte
   module DSL
     # Class methods for defining apps
-    module ClassMethods
+    module Definition
       def meta
         @meta ||= {}
       end
@@ -49,12 +48,13 @@ module Belafonte
       end
 
       def arg(name, arg_options = {})
-        args.last.tap do |arg|
-          if arg && arg.unlimited?
-            raise Belafonte::Errors::InvalidArgument.new("You may not add other arguments after an unlimited argument")
-          else
-            args.push(Belafonte::Argument.new(arg_options.merge({name: name})))
-          end
+        if has_unlimited_arg?
+          raise Belafonte::Errors::InvalidArgument.new("You may not add other arguments after an unlimited argument")
+      
+        else
+        
+          args.push(Belafonte::Argument.new(arg_options.merge({name: name})))
+          
         end
       end
 
@@ -70,6 +70,10 @@ module Belafonte
         raise Belafonte::Errors::CircularMount.new("An app cannot mount itself") if app == self
         subcommands.push(app)
       end
+
+      def has_unlimited_arg?
+        !(args.find {|arg| arg.unlimited?}).nil?
+      end
     end
   end
 end

data/lib/belafonte/dsl.rb

@@ -1,14 +1,10 @@
-require 'belafonte/dsl/instance_methods'
-require 'belafonte/dsl/class_methods'
+require 'belafonte/dsl/definition'
 
 module Belafonte
   # A DSL for making apps
   module DSL
     def self.included(klass)
-      klass.extend(Belafonte::DSL::ClassMethods)
+      klass.extend(Belafonte::DSL::Definition)
     end
-
-    include Belafonte::DSL::InstanceMethods
-    #include Belafonte::DSL::Mountin
   end
 end

data/lib/belafonte/flag.rb

@@ -10,13 +10,21 @@ module Belafonte
 
     attr_reader :name, :short, :long, :description
 
+    def self.shortify(option)
+      "-#{option.to_s}"
+    end
+
+    def self.longify(option)
+      "--#{option.to_s}"
+    end
+
     def normalize_flag(flag)
       flag.to_s.strip.gsub(/\s+/, '-')
     end
 
     def initialize(options = {})
       options[:name].tap do |name|
-        unless options[:name]
+        unless name
           raise Belafonte::Errors::NoName.new("Flag name cannot be blank")
         end
         @name = name.to_sym
@@ -47,11 +55,11 @@ module Belafonte
 
     private
     def shortify(option)
-      shortened = "-#{option.to_s}"
+      self.class.shortify(option)
     end
 
     def longify(option)
-      "--#{option.to_s}"
+      self.class.longify(option)
     end
 
     def flag_array(items)

data/lib/belafonte/help/flag_extensions.rb

@@ -1,3 +1,5 @@
+require 'belafonte/flag'
+
 module Belafonte
   module Help
     module FlagExtensions

data/lib/belafonte/help/generator.rb

@@ -22,24 +22,24 @@ module Belafonte
       end
 
       def name_section
-        "NAME\n#{Wrapomatic.new("#{app.display_title} - #{app.summary}").wrapped}\n"
+        "NAME\n#{Wrapomatic.wrap("#{app.display_title} - #{app.summary}", 1)}\n"
       end
 
       def synopsis
-        synopsis = "\nSYNOPSIS\n#{Wrapomatic.new(app.full_path).wrapped}"
+        synopsis = "\nSYNOPSIS\n#{Wrapomatic.wrap(app.full_path, 1)}"
         if app.description
-          synopsis += "\n\n#{Wrapomatic.wrap(app.display_description)}"
+          synopsis += "\n\n#{Wrapomatic.wrap(app.display_description, 1)}"
         end
         synopsis + "\n"
       end
 
       def options
-        return '' unless app.has_flags?
         options = "\nOPTIONS\n"
         app.sorted_flags.each do |flag|
           flag.extend(FlagExtensions)
-          options += "#{Wrapomatic.new(flag.signature).wrapped}"
+          options += "#{Wrapomatic.wrap(flag.signature, 1)}\n"
         end
+        options += "#{Wrapomatic.wrap('-h, --help - Shows this message', 1)}"
 
         options + "\n"
       end
@@ -50,7 +50,7 @@ module Belafonte
 
         app.sorted_commands.each do |command|
           command.extend(CommandExtensions)
-          commands += "#{Wrapomatic.new("#{command.display_title} - #{command.display_summary}").wrapped}\n"
+          commands += "#{Wrapomatic.wrap("#{command.display_title} - #{command.display_summary}", 1)}\n"
         end
 
         commands + "\n"

data/lib/belafonte/helpers/arguments.rb

@@ -0,0 +1,13 @@
+module Belafonte
+  module Helpers
+    module Arguments
+      def args
+        @arguments ||= {}
+      end
+
+      def arg(arg)
+        args[arg]
+      end
+    end
+  end
+end

data/lib/belafonte/helpers/flags.rb

@@ -0,0 +1,21 @@
+module Belafonte
+  module Helpers
+    module Flags
+      def switches
+        @switches ||= {}
+      end
+
+      def switch_active?(switch)
+        switches[switch]
+      end
+
+      def options
+        @options ||= {}
+      end
+
+      def option(option)
+        options[option]
+      end
+    end
+  end
+end

data/lib/belafonte/helpers/meta_data.rb

@@ -0,0 +1,33 @@
+module Belafonte
+  module Helpers
+    module MetaData
+      def title
+        self.class.info(:title)
+      end
+
+      def summary
+        self.class.info(:summary)
+      end
+
+      def description
+        self.class.info(:description)
+      end
+
+      def configured_switches
+        self.class.switches
+      end
+
+      def configured_options
+        self.class.options
+      end
+
+      def configured_args
+        self.class.args
+      end
+
+      def configured_subcommands
+        self.class.subcommands
+      end
+    end
+  end
+end

data/lib/belafonte/helpers/restricted.rb

@@ -0,0 +1,22 @@
+module Belafonte
+  module Helpers
+    # Instance methods for apps
+    module Restricted
+      protected
+
+      def activate_help!
+        @help = true
+      end
+
+      private
+
+      def help
+        @help ||= false
+      end
+
+      def help_active?
+        help
+      end
+    end
+  end
+end

data/lib/belafonte/helpers/sharing.rb

@@ -0,0 +1,15 @@
+require 'belafonte/senora'
+
+module Belafonte
+  module Helpers
+    module Sharing
+      def share(key, value)
+        Belafonte::Senora.store(key, value)
+      end
+
+      def partake(key)
+        Belafonte::Senora.retrieve(key)
+      end
+    end
+  end
+end

data/lib/belafonte/helpers/subcommands.rb

@@ -0,0 +1,11 @@
+module Belafonte
+  module Helpers
+    # Instance methods for apps
+    module Subcommands
+      
+      def subcommands
+        @subcommands ||= []
+      end
+    end
+  end
+end

data/lib/belafonte/helpers.rb

@@ -0,0 +1,17 @@
+require 'belafonte/helpers/meta_data'
+require 'belafonte/helpers/sharing'
+require 'belafonte/helpers/flags'
+require 'belafonte/helpers/arguments'
+require 'belafonte/helpers/subcommands'
+require 'belafonte/helpers/restricted'
+
+module Belafonte
+  module Helpers
+    include MetaData
+    include Sharing
+    include Flags
+    include Arguments
+    include Subcommands
+    include Restricted
+  end
+end

data/lib/belafonte/parser.rb

@@ -24,10 +24,6 @@ module Belafonte
       }
     end
 
-    def help
-      parser.to_s
-    end
-
     def parser
       @parser ||= OptionParser.new
     end

data/lib/belafonte/rhythm.rb

@@ -0,0 +1,87 @@
+require 'optparse'
+require 'belafonte/errors'
+require 'belafonte/help'
+require 'belafonte/parser'
+require 'belafonte/helpers'
+require 'belafonte/wrapomatic'
+
+module Belafonte
+  module Rhythm
+    def execute!
+      (@parser = Parser.new(
+        switches: configured_switches,
+        options: configured_options,
+        commands: configured_subcommands,
+        arguments: configured_args,
+        argv: @argv
+      )).parsed.tap do |parsed|
+        @switches = parsed[:switches]
+        @options = parsed[:options]
+        @arguments = parsed[:args]
+        activate_help! if parsed[:help]
+      end
+
+      @command = arg(:command).shift if arg(:command)
+
+      begin
+        run_setup
+
+        unless dispatch || show_help || run_handle
+          stderr.puts "No handler for the provided command line"
+          return 1
+        end
+      rescue => uncaught_error
+        stderr.puts "The application encountered the following error:"
+        stderr.puts Wrapomatic.wrap(uncaught_error.to_s, 1)
+        return 255
+      end
+
+      0
+    end
+
+    private
+    def parent
+      @parent
+    end
+
+    def subcommand_instance(command)
+      command_class = configured_subcommands.
+        find {|subcommand| subcommand.info(:title) == command}
+
+      return nil unless command_class
+
+      command_class.new(arg(:command), stdin, stdout, stderr, kernel, self)
+    end
+
+    def dispatch
+      return false if @command.nil?
+      handler = subcommand_instance(@command)
+
+      unless handler
+        activate_help!
+        return false
+      end
+
+      handler.activate_help! if help_active?
+      handler.execute!
+      true
+    end
+
+    def show_help
+      return false unless help_active?
+      stdout.print Belafonte::Help.content_for(self)
+      true
+    end
+
+    def run_handle
+      return false unless respond_to?(:handle)
+      handle
+      true
+    end
+
+    def run_setup
+      return nil unless respond_to?(:setup)
+      setup
+    end
+  end
+end

data/lib/belafonte/senora.rb

@@ -0,0 +1,19 @@
+module Belafonte
+  module Senora
+    def self.store(key, value)
+      data[key] = value
+    end
+
+    def self.retrieve(key)
+      data[key]
+    end
+
+    def self.data
+      @data ||= {}
+    end
+
+    def self.reset
+      @data = {}
+    end
+  end
+end

data/lib/belafonte/version.rb

@@ -1,3 +1,3 @@
 module Belafonte
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/belafonte/wrapomatic.rb

@@ -2,25 +2,18 @@ module Belafonte
   class Wrapomatic
     attr_reader :text, :lines, :indents, :columns
 
-    def self.wrap(text, indents = 1, columns = 80)
+    def self.wrap(text, indents = 0, columns = 80)
       new(text, indents, columns).wrapped
     end
 
-    def initialize(text, indents = 1, columns = 80)
-      @text = text
+    def initialize(text, indents = 0, columns = 80)
+      @text = text.split("\n").join(' ')
       @indents = indents
       @columns = columns
       @lines = []
       indentomize
     end
 
-    def refresh(text, indents = 1, columns = 80)
-      @text = text
-      @remainder = ''
-      @lines = []
-      indentomize
-    end
-
     def wrapped
       lines.join("\n")
     end
@@ -28,9 +21,9 @@ module Belafonte
     private
 
     def indentomize
-      begin
-        @lines.push(next_line)
-      end until next_line.nil?
+      until (line = next_line).nil?
+        @lines.push(line)
+      end
     end
 
     def next_line

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belafonte
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dennis Walters
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,8 +109,7 @@ files:
 - lib/belafonte/argument.rb
 - lib/belafonte/argument_processor.rb
 - lib/belafonte/dsl.rb
-- lib/belafonte/dsl/class_methods.rb
-- lib/belafonte/dsl/instance_methods.rb
+- lib/belafonte/dsl/definition.rb
 - lib/belafonte/errors.rb
 - lib/belafonte/flag.rb
 - lib/belafonte/help.rb
@@ -118,9 +117,17 @@ files:
 - lib/belafonte/help/command_extensions.rb
 - lib/belafonte/help/flag_extensions.rb
 - lib/belafonte/help/generator.rb
-- lib/belafonte/helpers/tokens.rb
+- lib/belafonte/helpers.rb
+- lib/belafonte/helpers/arguments.rb
+- lib/belafonte/helpers/flags.rb
+- lib/belafonte/helpers/meta_data.rb
+- lib/belafonte/helpers/restricted.rb
+- lib/belafonte/helpers/sharing.rb
+- lib/belafonte/helpers/subcommands.rb
 - lib/belafonte/option.rb
 - lib/belafonte/parser.rb
+- lib/belafonte/rhythm.rb
+- lib/belafonte/senora.rb
 - lib/belafonte/switch.rb
 - lib/belafonte/version.rb
 - lib/belafonte/wrapomatic.rb

data/lib/belafonte/dsl/instance_methods.rb

@@ -1,98 +0,0 @@
-require 'belafonte/parser'
-
-module Belafonte
-  module DSL
-    # Instance methods for apps
-    module InstanceMethods
-      def title
-        self.class.info(:title)
-      end
-
-      def summary
-        self.class.info(:summary)
-      end
-
-      def description
-        self.class.info(:description)
-      end
-
-      def configured_switches
-        self.class.switches
-      end
-
-      def configured_options
-        self.class.options
-      end
-
-      def configured_args
-        self.class.args
-      end
-
-      def configured_subcommands
-        self.class.subcommands
-      end
-
-      def switches
-        @switches ||= {}
-      end
-
-      def switch_active(switch)
-        switches[switch]
-      end
-
-      def options
-        @options ||= {}
-      end
-
-      def option(option)
-        options[option]
-      end
-
-      def args
-        @arguments ||= {}
-      end
-
-      def arg(arg)
-        args[arg]
-      end
-
-      def subcommands
-        @subcommands ||= []
-      end
-
-      def estate
-        @estate ||= {}
-      end
-
-      def bequeathed(name, value)
-        estate[name] ||= value
-      end
-      
-      def activate_help!
-        @help = true
-      end
-
-      private
-
-      def parser
-        @parser
-      end
-
-      #def short(option)
-        #"-#{option.to_s}"
-      #end
-
-      #def long(option)
-        #"-#{short(option)}"
-      #end
-
-      def help
-        @help ||= false
-      end
-
-      def help_active?
-        help
-      end
-    end
-  end
-end

data/lib/belafonte/helpers/tokens.rb

@@ -1,10 +0,0 @@
-module Belafonte
-  module Helpers
-    # deprecated tokenizer
-    module Tokens
-      def command_tokens
-        commands.keys
-      end
-    end
-  end
-end