go_script 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a33d0f56a637c8da9a53652adc002a7a9f1b58a
-  data.tar.gz: c696612e2b13fd0188cdfdd4262aaf46ebd35f58
+  metadata.gz: f496bded6c9673222755b3041dba2248c74a1b8f
+  data.tar.gz: f9181e7c59e91011b17a3d05b4ea241f254a0a0a
 SHA512:
-  metadata.gz: 256d24a8a8c2a325dda36883717296185664c91e9d4a619bb56504f54467ddae3906db7e8303881f9fd6d95cd6273e73b1e6d830717221d1df47cf26e09b870e
-  data.tar.gz: 136735601a89dd6c735a0393663f505f46a004f3ab4383ea5409eb58273653ae168b5cafd13b722b0dffd33f6510191fa3102bfdfc0b1e953ce0c522cef9c9a8
+  metadata.gz: 1c69760ad3ab8269f1f61204e9291d275b4cd07f737d3962f77e5f193bfd570d093d5dcbfb509d64520c31a2c9f5b1b19d7d87fbab6c6d562f869721a1e2f717
+  data.tar.gz: cc918316e22269bca1e7a1a527464999bad3a6fafda21cd50eeaeddabcb0fddb9e92b05acf80cd8bb18c6a7fa468ae8893e4095483a4a33bcbaa34494b56d267

data/README.md

@@ -20,20 +20,20 @@ language](https://golang.org). This convention is completely unrelated,
 though it does bear a great deal of resemblance to the Go language's `go`
 command.
 
-### Installation
+### Everyone: install Ruby
 
 Install [the Ruby programming language](https://www.ruby-lang.org/) if it
 isn't already present on your system. We recommend using a Ruby version
 manager such as [rbenv](https://github.com/sstephenson/rbenv) or
 [rvm](https://rvm.io/) to do this.
 
-Install [Bundler](http://bundler.io/) via `gem install bundler`.
+### Project authors: creating a `./go` script
 
-Finally, install the `go_script` gem via `gem install go_script`. You may also
-wish to add it to the [`Gemfile`](http://bundler.io/gemfile.html) of your
-project to ensure version consistency.
+Install the `go_script` gem via `gem install go_script`.
 
-### Creating a `./go` script
+To ensure version consistency for all developers, install
+[Bundler](http://bundler.io/) via `gem install bundler` and add `gem
+'go_script'` to your project's [`Gemfile`](http://bundler.io/gemfile.html).
 
 To create a fresh new `./go` script for your project, run:
 
@@ -49,6 +49,17 @@ $ bundle exec go-script-template > ./go
 $ chmod 700 ./go
 ```
 
+As a bonus, if the project only needs to initialize itself by installing Ruby
+gems from a `Gemfile`, there is no need to define an `init` command. The
+`./go` script will automatically install Bundler and run `bundle install`.
+
+### Project contributors: bootstrapping
+
+If the project already has a `./go` script, you do not need to install
+anything first other than Ruby. Just run the `./go` script. It will
+automatically install the `go_script` gem, either via Bundler (if a `Gemfile`
+is present) or directly using `gem install`.
+
 ### Listing commands
 
 To see the list of available commands for a script: run `./go help` (or one of
@@ -63,9 +74,7 @@ options:
   -v,--version  Show the version of the go_script gem
 
 Development commands
-  init         Set up the development environment
   update_gems  Update Ruby gems
-  update_js    Update JavaScript components
   test         Execute automated tests
   lint         Run style-checking tools
   ci_build     Execute continuous integration build
@@ -80,7 +89,6 @@ comprise the `./go` script interface. Its arguments are:
 - *id*: A [Ruby symbol](http://ruby-doc.org/core-2.2.3/Symbol.html)
   (basically, a string starting with `:` with no quotes around it) defining
   the name of the command.
-- *command_group*: A `CommandGroup` instance associated with the command.
 - *description*: A very brief description of the command that appears in the
   usage text.
 
@@ -90,13 +98,27 @@ directives from [`lib/go_script/go.rb`](lib/go_script/go.rb) that may be used
 to define commands, and commands may be built up from other commands defined
 in the `./go` script itself.
 
+**Note:** Command names must be unique. Defining a command with a name already
+used elsewhere will cause the `./go` script to exit with an error message.
+
 #### Command groups
 
-A `CommandGroup` instance clusters a set of commands together.
-`go-script-template` generates a default `CommandGroup` instance called
-`dev_commands`; you are free to edit this definition, or to add additional
-`CommandGroup` instances to organize your individual command definitions and
-affect how they are displayed in the help/usage message.
+Each `command_group` invocation marks the beginning of a set of related
+commands. These groupings organize how commands are displayed in the
+help/usage message.
+
+`go-script-template` generates a default `command_group` called `:dev`. You
+are free to edit this definition, or to add additional `command_group`
+definitions.
+
+**Note:** Command group names must be unique, and command groups cannot be
+re-opened after their initial definition. Defining a command group with a name
+already used elsewhere will cause the `./go` script to exit with an error
+message.
+
+Also, command names must be unique across all command groups. Defining a
+command with the same name as that in another command group will also cause
+the `./go` script to exit with an error message.
 
 #### Command arguments
 
@@ -104,18 +126,17 @@ Commands may take command-line arguments, which are passed in as block
 variables. In the following example, the `./go init` command takes no
 arguments, and the `./go test` command takes an argument list that is appended
 as additional command line arguments to `rake test`. For example, `./go test`
-runs `bundle exec rate test` without any further arguments, while running
+runs `bundle exec rake test` without any further arguments, while running
 `./go test TEST=_test/go_test.rb` ultimately runs `bundle exec rake test
 TEST=_test/go_test.rb`.
 
 ```ruby
-dev_commands = GoScript::CommandGroup.add_group 'Development commands'
+command_group :dev, 'Development commands'
 
-def_command :init, dev_commands, 'Set up the development environment' do
-  install_bundle
+def_command :init, 'Set up the development environment' do
 end
 
-def_command :test, dev_commands, 'Execute automated tests' do |args|
+def_command :test, 'Execute automated tests' do |args = []|
   exec_cmd "bundle exec rake test #{args.join ' '}"
 end
 ```

data/bin/go-script-template

@@ -8,37 +8,48 @@ puts <<END_OF_TEMPLATE
 
 require 'English'
 
+Dir.chdir File.dirname(__FILE__)
+
+def try_command_and_restart(command)
+  exit $CHILD_STATUS.exitstatus unless system command
+  exec $PROGRAM_NAME, *ARGV
+end
+
 begin
-  require 'go_script'
+  require 'bundler/setup' if File.exist? 'Gemfile'
 rescue LoadError
-  puts 'Installing go_script gem...'
-  exit $CHILD_STATUS.exitstatus unless system 'gem install go_script'
+  try_command_and_restart 'gem install bundler'
+rescue SystemExit
+  try_command_and_restart 'bundle install'
 end
 
-GoScript::Version.check_ruby_version '#{RUBY_VERSION}'
+begin
+  require 'go_script'
+rescue LoadError
+  try_command_and_restart 'gem install go_script'
+end
 
 extend GoScript
+check_ruby_version '#{RUBY_VERSION}'
 
-BASEDIR = File.dirname(__FILE__)
-dev_commands = GoScript::CommandGroup.add_group 'Development commands'
+command_group :dev, 'Development commands'
 
-def_command :init, dev_commands, 'Set up the development environment' do
-  install_bundle
+def_command :init, 'Set up the development environment' do
 end
 
-def_command :update_gems, dev_commands, 'Update Ruby gems' do |gems|
+def_command :update_gems, 'Update Ruby gems' do |gems|
   update_gems gems
 end
 
-def_command :update_js, dev_commands, 'Update JavaScript components' do
+def_command :update_js, 'Update JavaScript components' do
   update_node_modules
 end
 
-def_command :test, dev_commands, 'Execute automated tests' do |args|
+def_command :test, 'Execute automated tests' do |args|
   exec_cmd "bundle exec rake test \#{args.join ' '}"
 end
 
-def_command :lint, dev_commands, 'Run style-checking tools' do |files|
+def_command :lint, 'Run style-checking tools' do |files|
   files = files.group_by { |f| File.extname f }
   lint_ruby files['.rb']
   lint_javascript BASEDIR, files['.js']

data/lib/go_script.rb

@@ -1,5 +1,4 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 require_relative './go_script/go'
-require_relative './go_script/command_group'
 require_relative './go_script/version'

data/lib/go_script/command_group.rb

@@ -1,36 +1,84 @@
 # Author: Mike Bland <michael.bland@gsa.gov>
 
+require 'English'
+require 'pathname'
+
 module GoScript
+  class Command
+    attr_reader :description, :path, :lineno
+
+    def initialize(description, path, lineno)
+      @description = description
+      @path = path
+      @lineno = lineno
+    end
+  end
+
   # Groups a set of commands by common function.
   class CommandGroup
-    attr_accessor :description, :commands
+    attr_reader :description, :path, :lineno
+    attr_accessor :commands
     private_class_method :new
 
-    # @param description [String] short description of the group
-    def initialize(description)
+    def initialize(description, path, lineno)
       @description = description
+      @path = path
+      @lineno = lineno
       @commands = {}
     end
 
     def to_s
       padding = (commands.keys.max_by(&:size) || '').size + 2
-      command_descriptions = commands.map do |name, desc|
-        format "  %-#{padding}s#{desc}", name
+      command_descriptions = commands.map do |name, command|
+        format "  %-#{padding}s#{command.description}", name
       end
       ["\n#{@description}"].concat(command_descriptions).join("\n")
     end
 
+    def include_command?(command_symbol)
+      commands.keys.include? command_symbol
+    end
+
     class <<self
-      attr_reader :groups
-      def add_group(description)
-        (@groups ||= []).push(new(description)).last
+      def groups
+        @groups ||= {}
       end
 
-      def command(command_sym)
-        if (groups || []).flat_map { |g| g.commands.keys }.include? command_sym
-          return command_sym
+      def location_path(target_path)
+        @base_path ||= Pathname.new(
+          File.dirname(File.expand_path $PROGRAM_NAME))
+        Pathname.new(File.expand_path target_path).relative_path_from @base_path
+      end
+
+      def check_not_defined(collection, label, key, path, lineno)
+        return unless (existing = collection[key])
+        previous = location_path existing.path
+        current = location_path path
+        prefix = previous == current ? 'line ' : previous + ':'
+        abort "#{current}:#{lineno}: #{label} \"#{key}\" " \
+          "already defined at #{prefix}#{existing.lineno}"
+      end
+
+      def add_group(group_symbol, description, path, lineno)
+        check_not_defined groups, 'Command group', group_symbol, path, lineno
+        groups[group_symbol] = new description, path, lineno
+      end
+
+      def command_defined?(command)
+        groups.values.each { |g| return true if g.include_command? command }
+      end
+
+      def add_command(command, group_symbol, description, path, lineno)
+        groups.values.each do |group|
+          check_not_defined group.commands, 'Command', command, path, lineno
         end
-        puts "Unknown option or command: #{command_sym}"
+        groups[group_symbol].commands[command] = Command.new(
+          description, path, lineno)
+      end
+
+      def command(command_sym)
+        return command_sym if command_defined? command_sym
+        $stderr.puts "Unknown option or command: #{command_sym}"
         usage exitstatus: 1
       end
 
@@ -43,7 +91,7 @@ options:
   -h,--help     Show this help
   -v,--version  Show the version of the go_script gem
 END_OF_USAGE
-        (groups || []).each { |group| output_stream.puts group }
+        (groups.values || []).each { |group| output_stream.puts group }
         exit exitstatus
       end
     end

data/lib/go_script/go.rb

@@ -5,17 +5,32 @@ require_relative './version'
 require 'English'
 
 module GoScript
-  def def_command(id, command_group, description, &command_block)
+  attr_reader :current_group
+
+  def check_ruby_version(min_version)
+    Version.check_ruby_version min_version
+  end
+
+  def command_group(group_symbol, description)
+    location = caller_locations(1, 1).first
+    CommandGroup.add_group(group_symbol, description,
+      location.path, location.lineno)
+    @current_group = group_symbol
+  end
+
+  def def_command(id, description, &command_block)
+    abort "#{$PROGRAM_NAME}: No command_groups defined" unless current_group
     abort "Command ID must be a symbol: #{id}" unless id.instance_of? Symbol
-    self.class.send :define_method, id, ->(argv) { command_block.call argv }
-    command_group.commands[id] = description
+    self.class.send :define_method, id, ->(*argv) { command_block.call(*argv) }
+    path, lineno = command_block.source_location
+    CommandGroup.add_command id, @current_group, description, path, lineno
   end
 
   def execute_command(argv)
     command = argv.shift
     CommandGroup.usage exitstatus: 1 if command.nil?
     CommandGroup.usage if ['-h', '--help', '-help', 'help'].include? command
-    send version if ['-v', '--version', 'version'].include? command
+    send :version if ['-v', '--version', 'version'].include? command
     send CommandGroup.command(command.to_sym), argv
   end
 
@@ -32,9 +47,7 @@ module GoScript
     begin
       require 'bundler'
     rescue LoadError
-      puts 'Installing Bundler gem...'
       exec_cmd 'gem install bundler'
-      puts 'Bundler installed; installing gems'
     end
     exec_cmd 'bundle install'
   end
@@ -63,9 +76,11 @@ module GoScript
     exec_cmd "#{JEKYLL_BUILD_CMD} #{extra_args}"
   end
 
-  def git_sync_and_deploy(commands)
+  def git_sync_and_deploy(commands, branch: nil)
     exec_cmd 'git stash'
+    exec_cmd "git checkout -b #{branch}" unless branch.nil?
     exec_cmd 'git pull'
+    exec_cmd 'bundle install' if File.exist? 'Gemfile'
     commands.each { |command| exec_cmd command }
   end
 

data/lib/go_script/version.rb

@@ -1,7 +1,7 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 module GoScript
-  VERSION = '0.0.0'
+  VERSION = '0.1.0'
 
   class Version
     def self.check_ruby_version(min_version)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: go_script
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Mike Bland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-21 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler