sobriquet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf6d3e32b9e230a2726af9884eee6bb765ae9c9a
+  data.tar.gz: 4feade591a9a7221aeca7554691cdab992af8ca4
+SHA512:
+  metadata.gz: 5cae0cab28b40a27e364e578fc9a6414eb2bb72105b2181a64188b3f484578bd6df74a156a6f917412b63594cb4cd49b9f7f6ee8892690cf311764b25b17c966
+  data.tar.gz: 48eed1cab71694eb59f4140a2a9dfdbebdb629cb034c42f2103da099d33e20d8f36317713b7703befe4f18ec07116c07dbd94e25d939f1f1f59c51d61636543e

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# 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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+require: rubocop-rspec
+AllCops:
+  Exclude:
+    - 'pkg/**/*'
+    - 'vendor/**/*'
+    - 'features/**/*'
+    - 'sobriquet.gemspec'
+    - 'Rakefile'
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    sobriquet (0.0.1)
+      gli (= 2.14.0)
+      mustache (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.14.1)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    ast (2.2.0)
+    builder (3.2.2)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    contracts (0.14.0)
+    cucumber (2.3.3)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.4.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 3.2.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.4.0)
+      gherkin (~> 3.2.0)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.10)
+    gherkin (3.2.0)
+    gli (2.14.0)
+    json (1.8.3)
+    multi_json (1.12.0)
+    multi_test (0.1.2)
+    mustache (1.0.3)
+    parser (2.3.1.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (11.1.2)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.40.0)
+      parser (>= 2.3.1.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.5.0)
+      rubocop (>= 0.40.0)
+    ruby-progressbar (1.8.1)
+    thor (0.19.1)
+    unicode-display_width (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  rake
+  rdoc
+  rspec
+  rubocop
+  rubocop-rspec
+  sobriquet!

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rubocop/rake_task'
+Rake::RDocTask.new do |rd|
+  rd.main = 'README.rdoc'
+  rd.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'bin/**/*')
+  rd.title = 'Sobriquet'
+end
+
+spec = eval(File.read('sobriquet.gemspec'))
+
+Gem::PackageTask.new(spec)
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = 'features --format progress -x'
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts = opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task cucumber: :features
+task 'cucumber:wip' => 'features:wip'
+task wip: 'features:wip'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec'
+end
+
+task default: [:test, :features]

data/bin/sobriquet

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'sobriquet'
+
+include GLI::App
+include Sobriquet
+
+program_desc 'Sobriquet manage your alias'
+
+version Sobriquet::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+desc 'Show more retroaction'
+switch [:v, :verbose]
+
+desc 'Path of the workspace foder for sobriquet'
+default_value ENV['HOME']
+arg_name 'workspace'
+flag [:w, :workspace]
+
+desc 'Initalise sobriquet files'
+command :init do |command|
+  command.action do |global_options, _options, _args|
+    workspace = global_options['workspace']
+    csv = workspace + '/sobriquet.csv'
+    template_path = File.expand_path('../../templates/sobriquet.csv', __FILE__)
+    FileUtils.cp template_path, csv
+    puts 'Initialise a new sobriquet workspace in ' + workspace
+  end
+end
+
+def add_a_sobriquet(name)
+  lambda do |global_options, options, args|
+    description = options['description']
+    sobriquet, value, = args
+    csv = global_options['workspace'] + '/sobriquet.csv'
+    persistance = Persistance.new(csv)
+    commands = CommandCollection.new(persistance)
+    commands.add([value, sobriquet, description])
+    puts "Added new #{name} #{sobriquet} | #{value}"
+    puts "Sobriquet added to the file #{csv}" if global_options['verbose']
+  end
+end
+
+arg :sobriquet
+arg :command
+desc 'Add an alias for a variable'
+command :variable do |command|
+  command.desc 'Description of the variable'
+  command.default_value 'no description'
+  command.arg_name 'a bad description is better than no description'
+  command.flag [:d, :description]
+  command.action(&add_a_sobriquet(:variable))
+end
+
+arg :sobriquet
+arg :value
+desc 'Add an alias for a command'
+command :add do |command|
+  command.desc 'Description of the alias'
+  command.default_value 'no descriptions'
+  command.arg_name 'a bad description is better than no description'
+  command.flag [:d, :description]
+  command.action(&add_a_sobriquet(:sobriquet))
+end
+
+desc 'Generate a shell file from sobriquet data'
+command :generate do |command|
+  command.action do |global_options, _options, _args|
+    csv = global_options['workspace'] + '/sobriquet.csv'
+    shell_path = global_options['workspace'] + '/sobriquet.sh'
+    verbose = global_options['verbose']
+    persistance = Persistance.new(csv)
+    script = CommandCollection.new(persistance).compile
+    File.open(shell_path, 'w') do |file|
+      file.write script
+    end
+    puts 'generate alias file ' + shell_path + ' from csv file' + csv
+    puts "alias generated from the csv file #{csv}" if verbose
+  end
+end
+
+exit run(ARGV)

data/features/alias.feature

@@ -0,0 +1,24 @@
+Feature: Add alias to sobriquet data file
+
+  Background:
+    Given a mocked home directory
+    And a file named "sobriquet.csv" with:
+    """
+    command | alias | description
+    """
+
+  Scenario: Add an alias with descriptions
+    When I run `sobriquet add -d 'get the status of the git directory' gs 'git status' `
+    Then the output should contain:
+    """
+    Added new sobriquet gs | git status
+    """
+    And the file named "sobriquet.csv" should contain:
+    """
+    "git status" | gs | "get the status of the git directory"
+    """
+
+  Scenario: Add an alias with verbose flag
+    When I run `sobriquet --verbose add gs 'git status' `
+    Then the output should match /Sobriquet added to the file .*sobriquet.csv/
+

data/features/generate.feature

@@ -0,0 +1,35 @@
+Feature: Generate a shell file to declare alias and import variables
+
+  Background:
+    Given a mocked home directory
+    And a file named "sobriquet.csv" with:
+    """
+    command | alias | description | type
+    "git status" | gs | "get the status of the git directory" | command
+    "origin master" | om | "no description" | variable
+    """
+
+  Scenario: generate the alias file every time i run the generate command
+    When I run `sobriquet generate`
+    And I run `sobriquet generate`
+    Then the output should contain:
+    """
+    generate alias file
+    """
+    And the file named "sobriquet.sh" should contain:
+    """
+    # description : get the status of the git directory
+    """
+    And the file named "sobriquet.sh" should contain:
+    """
+    alias gs="git status"
+    """
+    And the file named "sobriquet.sh" should contain:
+    """
+    export om="origin master"
+    """
+
+  Scenario: Generate the alias flag with verbose flag
+    When I run `sobriquet --verbose generate`
+    Then the output should match /alias generated from the csv file .*sobriquet.csv/
+

data/features/init.feature

@@ -0,0 +1,24 @@
+Feature: Initialise a new workspace
+
+  Background:
+    Given a mocked home directory
+
+  Scenario: Init a new folder with a csv file for the aliases
+    When I run `sobriquet init`
+    Then the file named "sobriquet.csv" should contain:
+    """
+    command | alias | description
+    """
+    And the output should contain:
+    """
+    Initialise a new sobriquet workspace in
+    """
+
+  Scenario: Init a new directory with a workspace option
+    Given an empty directory named "test"
+    When I run `sobriquet --workspace=test init `
+    Then the output should contain:
+    """
+    Initialise a new sobriquet workspace in test
+    """
+

data/features/sobriquet.feature

@@ -0,0 +1,6 @@
+Feature: Sobriquet alias management
+
+  Scenario: App just runs
+    When I get help for "sobriquet"
+    Then the exit status should be 0
+

data/features/step_definitions/sobriquet_steps.rb

@@ -0,0 +1,6 @@
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} help`)
+end
+
+# Add more step definitions here

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/features/variable.feature

@@ -0,0 +1,25 @@
+Feature: Add a variable to sobriquet data file
+
+  Background:
+    Given a mocked home directory
+    And a file named "sobriquet.csv" with:
+    """
+    command | alias | description
+    """
+
+  @wip
+  Scenario: Add a variable
+    When I run `sobriquet variable om 'origin master'`
+    Then the output should contain:
+    """
+    Added new variable om | origin master
+    """
+    And the file named "sobriquet.csv" should contain:
+    """
+    "origin master" | om | "no description"
+    """
+
+  Scenario: Add an variable with verbose flag
+    When I run `sobriquet --verbose variable om 'origin master' `
+    Then the output should match /Sobriquet added to the file .*sobriquet.csv/
+