command-genie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11a2636ffc746bc889411db5f462c842f9424225
+  data.tar.gz: ddf02d4e967230bb8ffe61c60b11c1ad9057104f
+SHA512:
+  metadata.gz: b92219021daa5967a8e22b1c417ebfddfadca0fb0601573b0399036b469f666077bd6f1a985dc43a38b5f497fe7a7d9a93438ac5902bf6f9aeb851212a4393d1
+  data.tar.gz: e814d32b16f7d0c1ebf80ba177bb2595a39e9574a72608dba80537fa3249de4e0b1d7808f1bdb08f2546b417e99132b2d3230b2970424fe30edbbadb6dd47615

data/.gitignore

@@ -0,0 +1,45 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+vendor/Pods/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+## Mac
+.DS_Store
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+tags

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2016, Hwee-Boon Yar
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,47 @@
+About
+---
+As developers, we try to automate and build shortcuts to improve our workflow. Sometimes we always run the same command in a specific project directory and a slightly different command or the same command with slightly different parameters in another.
+
+A good example is when pushing code, we might run `git push origin master` for one repository, but for another, we might want to run `hub push origin,deploy master` instead. `genie` helps you do that.
+
+`genie` lets you create commands that are bound to directories. In our example, we can create a `push` command that, depending on which directory we run it in, invoke the correct push command.
+
+Usage
+---
+Here's how to create a command with `genie`:
+
+1. Create a YAML configuration file matching the softlink in your user directory's `.config` directory. e.g. For the command called `push`, you would create `~/.config/push.yml`.
+
+    Contents for the YAML file are key-value mappings from a directory path to the command to be ran in that directory (and it's subdirectories):
+
+    ```
+    /Users/hboon/code/piggyalarm: git push bb master
+    /Users/hboon/code/simplymeta: hub push bb,deploy master
+    ~/code/ligify: git push bb master
+    ```
+
+    You can also run `genie create <command>` to help you create a sample YAML file.
+
+2. Create a softlink to `genie` with a sensible name and make sure it's in your $PATH, e.g.
+
+    ```
+    ln -s genie push
+    ```
+
+Installation
+---
+`gem install command-genie`
+
+Dependencies
+---
+* [commander](https://github.com/tj/commander)
+
+License
+---
+BSD
+
+Questions
+---
+* Email: [hboon@motionobj.com](mailto:hboon@motionobj.com)
+* Web: [http://hboon.com/genie/](http://hboon.com/genie/)
+* Twitter: [https://twitter.com/hboon](https://twitter.com/hboon)

data/bin/genie

@@ -0,0 +1,172 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require 'fileutils'
+require 'psych'
+
+APP_NAME = 'genie'
+HELP_STRING = "Create commands bound to directories. E.g. create a `push` command 
+that, depending on which directory you are in, run the correct git 
+push command.
+
+----------
+
+You can either create the command and config file 
+semi-automatically:
+
+1. Run:
+
+  $ #{APP_NAME} create <command>
+
+This will create a YAML file `~/.config/#{APP_NAME}/<command>.yml` 
+and the command (a softlink) in the current directory.
+  
+2. Move this softlink to a directory in your $PATH so that you can 
+run the command anywhere.
+
+  $ mv <command> /some/directory/included/in/path/
+
+----------
+
+Alternatively, you can create them manually:
+
+1. Figure out where `#{APP_NAME}` is installed.
+
+  $ which #{APP_NAME}
+
+2. Create a softlink to `#{APP_NAME}` with a sensible name and make 
+sure this softlink is in your $PATH. This will be your new command 
+e.g.
+
+    $ ln -s /full/path/to/#{APP_NAME}/from/step1 push
+
+3. Create a YAML configuration file matching the softlink in your 
+user directory's `.config/#{APP_NAME}/` directory. e.g. For the 
+command called `push`, you would create 
+`~/.config/#{APP_NAME}/push.yml`.
+
+Contents for the YAML file are key-value mappings from a directory 
+path to the command to be ran in that directory (and its 
+subdirectories):
+
+    ---
+    /Users/hboon/code/piggyalarm: git push bb master
+    /Users/hboon/code/simplymeta: hub push bb,deploy master
+    ~/code/ligify: git push bb master
+
+---
+
+Either way, update the configuration file at 
+`~/.config/#{APP_NAME}/<command>.yml` with the commands for each 
+directory.
+"
+TICK_CHAR = "\u2713"
+
+program :version, '0.0.1'
+program :description, HELP_STRING
+
+script_name = File.basename(__FILE__)
+
+if script_name == APP_NAME
+  default_command :create
+else
+  default_command :run
+end
+
+def config_path(cmd)
+  File.expand_path("~/.config/#{APP_NAME}/#{cmd}.yml")
+end
+
+if script_name != APP_NAME
+  cmd_config_path = config_path(script_name)
+  command :run do |c|
+    c.syntax = "#{script_name}"
+    c.summary = "Run a command from #{cmd_config_path} that matches the current directory"
+    c.description = "Run a command from #{cmd_config_path} that matches the current directory"
+    c.example 'Run command', "$ #{script_name}"
+    c.action do |args, options|
+      #Careful, say doesn't return true-ish
+      if (script_name == APP_NAME && (args.nil? || args.empty?))
+        say HELP_STRING
+        abort
+      end
+      say_error "Specify the name of the new command you want to create:
+
+      #{APP_NAME} create <command>
+  " and abort if script_name == APP_NAME
+      File.open(cmd_config_path) do |f|
+        mapping = Psych.load(f.read)
+        mapping = Hash[mapping.map{|k,v|[k.chomp('/'), v]}]
+        dir = Dir.pwd
+        found = dir_matching(mapping.keys, dir)
+        cmd = mapping[found]
+        if cmd && !cmd.empty?
+          say "Running: #{cmd}"
+          `#{cmd}`
+        else
+          say_error "No matching command found for `#{dir}`."
+        end
+      end
+    end
+  end
+end
+
+if script_name == APP_NAME
+  command :create do |c|
+    c.syntax = "#{script_name}"
+    c.summary = "Create a command"
+    c.description = "Create a command"
+    c.example 'Create command', "$ #{APP_NAME} create <command>"
+    c.action do |args, options|
+      say_error "Specify the name of the new command you want to create:
+
+    #{APP_NAME} create <command>
+" and abort if args.nil? || args.empty?
+      new_cmd = args[0]
+      say_error "I don't think you want to do that." and abort if new_cmd == APP_NAME
+      cmd_config_path = config_path(new_cmd)
+      config_dir = File.dirname(cmd_config_path)
+      say_error "A file with the same name as the command/softlink `#{new_cmd}` already exist." and abort if File.file? new_cmd
+      say_error "Configuration file `#{cmd_config_path}` already exist." and abort if File.file? cmd_config_path
+      create_configuration_file(new_cmd, config_dir)
+      create_command(new_cmd)
+    end
+  end
+end
+
+def dir_matching(dirs, dir)
+  found = dirs.find {|e|e == dir || File.expand_path(e) == dir}
+  if found
+    found
+  else
+    dir = File.expand_path('..', dir)
+    if dir == '/'
+      nil
+    else
+      dir_matching(dirs, dir)
+    end
+  end
+end
+
+def genie_abs_path
+  @genie_abs_path ||= `which genie`.chomp
+end
+
+def create_configuration_file(new_cmd, config_dir)
+  dir = Dir.pwd
+  contents = "#{dir}: ENTER_YOUR_COMMAND_HERE
+/another_directory_path: ENTER_ANOTHER_COMMAND
+/yet_another_directory_path: AND_ANOTHER_COMMAND
+~/some_dir: AND_ANOTHER_COMMAND"
+  cmd_config_path = config_path(new_cmd)
+  FileUtils.mkdir_p(config_dir) unless File.directory? config_dir
+  File.open(cmd_config_path, 'w') {|f| f.write(contents)}
+  say "#{TICK_CHAR} Configuration file `#{cmd_config_path}` created."
+end
+
+def create_command(new_cmd)
+  `ln -s #{genie_abs_path} #{new_cmd}`
+  say "#{TICK_CHAR} New command (softlink) `#{new_cmd}` created by genie."
+  say "TODO: You should move `#{new_cmd}` to a directory included in your $PATH so you can use it anywhere."
+end

data/genie.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/genie/version.rb', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'command-genie'
+  gem.authors  = ['Hwee-Boon Yar']
+  gem.email = 'hboon@motionobj.com'
+  gem.version       = CommandGenie::VERSION
+
+  gem.licenses      = ['BSD']
+  gem.summary = 'genie — Run commands that are bound to directories.'
+  gem.description = gem.summary
+  gem.homepage = 'http://hboon.com/genie/'
+
+	gem.add_dependency 'commander', '~> 4.3'
+  gem.files       = `git ls-files`.split($\)
+  gem.executables   = ['genie']
+  gem.require_paths = ['lib']
+  #gem.test_files  = gem.files.grep(%r{^spec/})
+end

data/lib/genie.rb

@@ -0,0 +1 @@
+require 'genie/genie'

data/lib/genie/version.rb

@@ -0,0 +1,3 @@
+module CommandGenie
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: command-genie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hwee-Boon Yar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: genie — Run commands that are bound to directories.
+email: hboon@motionobj.com
+executables:
+- genie
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- bin/genie
+- genie.gemspec
+- lib/genie.rb
+- lib/genie/genie.rb
+- lib/genie/version.rb
+homepage: http://hboon.com/genie/
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: genie — Run commands that are bound to directories.
+test_files: []