sheet 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec"
+  gem "yard"
+  gem "rdoc"
+  gem "jeweler"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rdoc
+  rspec
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Oscar Del Ben
+
+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,69 @@
+# Sheet
+
+Easily create and access snippets of text from your terminal. `sheet` is
+your own personal wiki.
+
+```
+gem install sheet
+```
+
+Examples:
+```
+sheet           # with no arguments it will just list all your sheets
+sheet git       # opens git sheet
+sheet new git   # creates git sheet
+sheet edit git  # edit git sheet
+```
+
+Use `sheet new <term>` to create your first sheet. Useful for jotting
+down commands that you use often but somehow never remember.
+
+### Opening urls
+
+Found a great cheat sheet *online* about jquery or your favorite
+language? I've got you covered.
+
+When writing your snippet, you can use this special format to
+automatically open a url when opening your sheet:
+
+```
+url: http://example/com
+```
+
+Make sure that's you don't have trailing lines and sheet will
+automatically open that url for you
+
+Please note that to open urls, sheet will use the `open` command on mac
+os x and `xdg-open` in linux. Patches welcome for other systems.
+
+### Behind the scenes
+
+`sheet` stores your sheets in text files in the
+`~/.sheets` directory. You can go there and modify the files manually if you desire,
+or you can source them into version control and share them across
+multiple systems.
+
+For writing files, `sheet` looks for the `$EDITOR` global variable, and
+will raise an error if no editor was found.
+
+### Help your stuff is broken
+
+I tested this software in mac os x with Ruby 1.9. If you find any bug
+with other platforms/interpreters please let me know and I'll push a
+fix.
+
+### Contributing to sheet
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+### Copyright
+
+Copyright (c) 2012 Oscar Del Ben. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "sheet"
+  gem.homepage = "http://github.com/oscardelben/sheet"
+  gem.license = "MIT"
+  gem.summary = %Q{snippets for your command line}
+  gem.description = %Q{sheets allows you to store and browse snippets of text from your command line.}
+  gem.email = "info@oscardelben.com"
+  gem.authors = ["Oscar Del Ben"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/sheet

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '../lib/sheet')
+
+Sheet.new(ARGV).process

data/lib/sheet/list.rb

@@ -0,0 +1,9 @@
+
+class Sheet
+  class List
+
+    def list
+      Sheet.exec("ls #{Sheet.sheets_dir}")
+    end
+  end
+end

data/lib/sheet/open.rb

@@ -0,0 +1,44 @@
+class Sheet
+
+  class Open
+
+    attr_accessor :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def open
+      if Sheet.sheet_exists?(name)
+        process_sheet_content
+      else
+        Sheet.write "A cheat named #{name} doesn't exist.\nYou can create one with sheet new #{name}"
+      end
+    end
+
+    private
+
+    def process_sheet_content
+      if contains_url_format? && cmd = Sheet.open_command
+        # TODO: check if open is available
+        Sheet.exec "#{cmd} #{extract_url}"
+      else
+        Sheet.write sheet_content
+      end
+    end
+
+    def contains_url_format?
+      sheet_content.split("\n").size == 1 &&
+        sheet_content =~ /^url:\s*http.+$/
+    end
+
+    def extract_url
+      sheet_content.match(/(http.+)$/)[1]
+    end
+
+    def sheet_content
+      @sheet_content ||= File.read(Sheet.sheet_path(name))
+    end
+
+  end
+end

data/lib/sheet/write.rb

@@ -0,0 +1,30 @@
+
+class Sheet::Write
+
+  attr_accessor :name
+
+  def initialize(name)
+    @name = name
+  end
+
+  def write
+    create_dir_if_doesnt_exist
+    if editor_is_set?
+      Sheet.exec("#{Sheet.editor} #{Sheet.sheet_path(name)}", true)
+    else
+      Sheet.write "Please set the $EDITOR variable to write files" 
+    end
+  end
+
+  private
+
+  def editor_is_set?
+    (editor = Sheet.editor) && editor.length > 0
+  end
+
+  def create_dir_if_doesnt_exist
+    if ! Dir.exists?(Sheet.sheets_dir)
+      Dir.mkdir(Sheet.sheets_dir)
+    end
+  end
+end

data/lib/sheet.rb

@@ -0,0 +1,99 @@
+
+# The Sheet class allows to easily dispatch commands from the command
+# line. It also provides common functionality for other classes.
+
+require 'sheet/open'
+require 'sheet/write'
+require 'sheet/list'
+
+class Sheet
+
+  SHEETS_DIR = '~/.sheets/'.freeze
+
+  class << self
+    # Utility to write to standard output
+    def write(message)
+      puts message
+    end
+
+    # Utility to execute system commands
+    def exec(cmd, replace_current_process=false)
+      if replace_current_process
+        Kernel.exec cmd
+      else
+        %x!#{cmd}!
+      end
+    end
+
+    # @param [String] name the sheet name
+    # @return [String]
+    # Returns the path of a sheet, doesn't check if the file exists
+    def sheet_path(name)
+      File.join(sheets_dir, name)
+    end
+
+    # Where the sheets directory is (absolute path)
+    def sheets_dir
+      File.expand_path(SHEETS_DIR)
+    end
+
+    # @param [String] name the sheet name
+    # @return [true]
+    # Used to check if a sheet exists
+    def sheet_exists?(name)
+      name && File.exists?(sheet_path(name))
+    end
+
+    # @return [String]
+    # Used to check the preferred editor for the user
+    def editor
+      exec("echo $EDITOR").chomp
+    end
+
+    # If we're using mac, we should use open to open urls.
+    # If we're using linux, we can probably use xdg-open
+    # Otherwise return nil
+    def open_command
+      if RUBY_PLATFORM =~ /darwin/
+        'open'
+      elsif RUBY_PLATFORM =~ /linux/
+        'xdg-open'
+      else
+        nil
+      end
+    end
+
+  end
+
+  # Creates a new instance of Sheet, usually followed by a call to {#process}
+  # @param [Array] args command line options
+  def initialize(*args)
+    @args = args.flatten
+  end
+
+  # Where the dispatching really happens. We check to see what the user
+  # intended to do and then instantiate the proper class
+  def process
+    if ['new', 'edit'].include?(@args[0])
+      write(@args[1])
+    elsif ['ls', 'list'].include?(@args[0])
+      list
+    else
+      open(@args[0])
+    end
+  end
+
+  private
+
+  def open(name)
+    Sheet::Open.new(name).open
+  end
+
+  def write(name)
+    Sheet::Write.new(name).write
+  end
+
+  def list
+    Sheet::List.new.list
+  end
+end

data/spec/sheet/list_spec.rb

@@ -0,0 +1,13 @@
+
+require 'spec_helper'
+
+describe Sheet::List do
+
+  it 'calls system ls' do
+    cmd = "ls #{Sheet.sheets_dir}"
+    Sheet.should_receive(:exec).with(cmd)
+
+    Sheet::List.new.list
+  end
+
+end

data/spec/sheet/open_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Sheet::Open do
+
+  it "should show a message when the app doesn't exist" do
+    message = "A cheat named rails doesn't exist.\nYou can create one with sheet new rails"
+    Sheet.should_receive(:write).with(message)
+
+    Sheet::Open.new('rails').open
+  end
+
+  it "should output the sheet content" do
+    message = "My sheet about git"
+    Sheet.should_receive(:write).with(message)
+
+    s = Sheet::Open.new('git')
+    Sheet.stub(:sheet_exists?).with('git') { true }
+    s.stub(:sheet_content) { message }
+    s.open
+  end
+
+  it "should open a url" do
+    Sheet.stub(:open_command) { 'open' }
+    message = "url: http://example.com"
+    Sheet.should_receive(:exec).with('open http://example.com')
+
+    s = Sheet::Open.new('git')
+    Sheet.stub(:sheet_exists?).with('git') { true }
+    s.stub(:sheet_content) { message }
+    s.open
+  end
+
+  it "should fallback to showing the content if an open command is not present" do
+    Sheet.stub(:open_command) { nil}
+    message = "url: http://example.com"
+    Sheet.should_receive(:puts).with('url: http://example.com')
+
+    s = Sheet::Open.new('git')
+    Sheet.stub(:sheet_exists?).with('git') { true }
+    s.stub(:sheet_content) { message }
+    s.open
+  end
+end

data/spec/sheet/sheet_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Sheet do
+
+  describe 'opening sheets' do
+    it 'should instantiate Sheet::Open' do
+      open = double('Sheet::Open')
+      open.should_receive(:open)
+
+      Sheet::Open.stub(:new).with('cucumber') { open }
+      Sheet.new('cucumber').process
+    end
+  end
+
+  describe 'creating sheets' do
+    it 'should instantiate Sheet::Write' do
+      write = double('Sheet::Write')
+      write.should_receive(:write)
+
+      Sheet::Write.stub(:new).with('rails') { write }
+      Sheet.new('new', 'rails').process
+    end
+  end
+
+  describe 'editing sheets' do
+    it 'should instantiate Sheet::Write' do
+      write = double('Sheet::Write')
+      write.should_receive(:write)
+
+      Sheet::Write.stub(:new).with('rails') { write }
+      Sheet.new('edit', 'rails').process
+    end
+  end
+
+  describe 'list sheets' do
+    it 'should instantiate Sheet::List' do
+      list = double('Sheet::List')
+      list.should_receive(:list)
+
+      Sheet::List.stub(:new) { list }
+      Sheet.new('ls').process
+    end
+  end
+end

data/spec/sheet/write_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Sheet::Write do
+
+  let (:editor) { 'vim' }
+
+  it 'opens a new file for writing' do
+    cmd = "#{editor} #{Sheet.sheet_path('tmux')}"
+    Sheet.should_receive(:exec).with(cmd, true)
+
+    Sheet.stub(:editor) { editor }
+
+    Sheet::Write.new('tmux').write
+  end
+
+  it 'returns an error if no editor is found' do
+    Sheet.stub(:editor) { nil }
+    Sheet.should_receive(:write).with { "Please set the $EDITOR variable to write files" }
+
+    Sheet::Write.new('tmux').write
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'sheet'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: sheet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Oscar Del Ben
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: sheets allows you to store and browse snippets of text from your command
+  line.
+email: info@oscardelben.com
+executables:
+- sheet
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/sheet
+- lib/sheet.rb
+- lib/sheet/list.rb
+- lib/sheet/open.rb
+- lib/sheet/write.rb
+- spec/sheet/list_spec.rb
+- spec/sheet/open_spec.rb
+- spec/sheet/sheet_spec.rb
+- spec/sheet/write_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/oscardelben/sheet
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2530773601907253271
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: snippets for your command line
+test_files: []