dsh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 229d542c79cc7c2e6b25c4a1dd9200c3ba0fdb3b
+  data.tar.gz: 0304e59806df4f7ba0bdc09f8ac633b7f02a59d2
+SHA512:
+  metadata.gz: db2f08e6fd24bd1696a458cf3ebdc225ba25147741862c8b7eb5fbb09b4ffbec34fc7f4981671d63c8f2cc8b8203c362d56f94a2f360852014f7d38adf77acff
+  data.tar.gz: 61ec995f5118960033248934a2b95d667b8be92a073a2c431fba9c02023f19e4553391ec068b4194fc20cdb16a380df0c7a31971fabce407c88ba6b363eec1bb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dsh.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    dsh (0.1.0)
+      methadone (~> 1.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.3)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.3.8)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.1)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.4)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    json (1.8.1)
+    methadone (1.3.1)
+      bundler
+    multi_json (1.8.2)
+    multi_test (0.0.2)
+    rake (0.9.6)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler (~> 1.3)
+  dsh!
+  rake (~> 0.9.2)
+  rdoc

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Christopher Simpkins 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Dsh
+
+A command line search interface to programming language documentation in the Dash application (Mac OSX) with optional docset keyword filters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dsh'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dsh
+
+## Usage
+
+To search across all language docsets, simply enter your search query after the `dsh` command:
+
+	dsh <search_term(s)>
+
+To restrict your search to a specific programming language docset, use the `-l` or `--lang` flags with the docset keyword as the argument:
+
+	dsh -l ruby puts
+
+

data/README.rdoc

@@ -0,0 +1,19 @@
+= dsh - A command line search interface to programming language documentation in the Mac OSX Dash application.
+
+Author::  Christopher Simpkins
+Copyright:: Copyright (c) 2013 Christopher Simpkins
+
+
+License:: mit, see LICENSE.txt
+
+== Links
+
+* {Source on Github}[https://github.com/chrissimpkins/dsh]
+* RDoc[LINK TO RDOC.INFO]
+
+== Install
+
+== Examples
+
+== Contributing
+

data/Rakefile

@@ -0,0 +1,61 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+
+require 'rake/testtask'
+
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/tc_*.rb'
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :default => [:test,:features]
+

data/bin/dsh

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require 'open3'
+require 'dsh.rb'
+
+class App
+  include Methadone::Main
+  #include Methadone::CLILogging
+
+  main do |query|
+    language = options["l"]
+    search_command = Dsh.makeCommand(query, language)
+    stdout_str, stderr_str, status = Open3.capture3(search_command)
+    unless status.exitstatus == 0
+      STDERR.puts "Unable to launch Dash."
+      STDERR.puts stderr_str
+      exit 1
+    end
+  end
+
+  description "A command line interface to search programming language documentation in the Dash application (Mac OSX) with optional docset keyword filters."
+  # Docset Language Flag:
+  on("-l <language>","Language docset filter")
+  # Required argument
+  arg :query, :required
+
+  version Dsh::VERSION
+  
+  #use_log_level_option
+
+  go!
+end

data/dsh.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dsh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dsh"
+  spec.version       = Dsh::VERSION
+  spec.authors       = ["Chris Simpkins"]
+  spec.email         = ["git.simpkins@gmail.com"]
+  spec.description   = %q{A command line interface to search programming language documentation in the Dash application (Mac OSX) with optional docset keyword filters.}
+  spec.summary       = %q{dsh}
+  spec.homepage      = "http://rubygems.org/gems/dsh"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('rdoc')
+  spec.add_development_dependency('aruba')
+  spec.add_development_dependency('rake', '~> 0.9.2')
+  spec.add_dependency('methadone', '~> 1.3.1')
+end

data/features/dsh.feature

@@ -0,0 +1,13 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "dsh"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version|
+    And the banner should document that this app takes no arguments

data/features/step_definitions/dsh_steps.rb

@@ -0,0 +1 @@
+# Put your step definitions here

data/features/support/env.rb

@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'methadone/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/lib/dsh/version.rb

@@ -0,0 +1,3 @@
+module Dsh
+  VERSION = "0.1.0"
+end

data/lib/dsh.rb

@@ -0,0 +1,12 @@
+require "dsh/version"
+
+module Dsh
+    # supplemental methods here
+  def Dsh.makeCommand(query, language)
+    if language.to_s == ''
+      command = "open dash://" + query
+    else
+      command = "open dash://" + language + ":" + query
+    end
+  end #end makeCommand()
+end #end Dsh module

data/test/tc_something.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class TestSomething < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: dsh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Simpkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+description: A command line interface to search programming language documentation
+  in the Dash application (Mac OSX) with optional docset keyword filters.
+email:
+- git.simpkins@gmail.com
+executables:
+- dsh
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- bin/dsh
+- dsh.gemspec
+- features/dsh.feature
+- features/step_definitions/dsh_steps.rb
+- features/support/env.rb
+- lib/dsh.rb
+- lib/dsh/version.rb
+- test/tc_something.rb
+homepage: http://rubygems.org/gems/dsh
+licenses:
+- MIT
+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.1.10
+signing_key: 
+specification_version: 4
+summary: dsh
+test_files:
+- features/dsh.feature
+- features/step_definitions/dsh_steps.rb
+- features/support/env.rb
+- test/tc_something.rb