cheatly 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGMyM2JmZjdkNDRmYTFlYjY1MGZlZmRiNmFmOTY2YTQ5YzU4ZWRkYg==
-  data.tar.gz: !binary |-
-    NmE0ZGQ2ZDY3ZmRmMjYxY2YzNzk5ZGQ1N2ExMzAwNTljNTIwOGJmNA==
+SHA1:
+  metadata.gz: 421926d9ff00815422d160384717b4662abf87a7
+  data.tar.gz: 9c59d3a7dc556d9d590303257a3f92bcec4bdac8
 SHA512:
-  metadata.gz: !binary |-
-    OWM5MmQxMmEyYWQ4YjEyMDBkOGYzNDZkZGJiYjY1YzNlZjIzNzVmOGNmYmE3
-    OGI1MzdkNjc2YjVkN2VhMzllY2Q4M2NlNDAxYmU0ZjFlODZlYTZmYTAyMzc1
-    NmFmOTEwOWY0NDY3MjQ1YWM3NzJlNzZjYjEwYzdkNDNhOWZhYWM=
-  data.tar.gz: !binary |-
-    MjIzMTJiNDBkMzQwMzU5MWIxYzc3Zjc3MWQyZjI5ZDFiYTIyZGM2OTJkN2E3
-    ZWQxMGY0MDU5NDM1OTNhZWIzMzYzMDJhNjQwNWY3Y2JlOGVlMjgwZDQzMDBm
-    YmJiNmQ2NDQ4NThlNGM2MzE2OWI3ODI1NzUwZDg4M2ZkMDgxNTQ=
+  metadata.gz: 85f518f577e4c910a5e3ffd815bb23d93406c2fbb04a1665f98012408cd51439827aece7acefa34d8ddb1f6da20f010c1983ba21b0ddce9a0a9f387f9bb60f98
+  data.tar.gz: c1691f0f69cae08f3963fde38a5ebde04a8ceaf84fe782c63e77a3f9587ab1764a380b05b7d90086ed95fe5dcf51ceeaed6c21f9d895bb7d7713882aaa447fc6

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+
+script: bundle exec rake test

data/README.md

@@ -1,5 +1,7 @@
 # Cheatly
 
+[![Build Status](https://travis-ci.org/arthurnn/cheatly.png?branch=master)](https://travis-ci.org/arthurnn/cheatly)
+
 This is a command line toolset to handle the cheat-sheets reposity located at [sheets](https://github.com/arthurnn/cheatly/tree/master/sheets) folder.
 
 This gem is not a fork but inspired by [defunkt/cheat](https://github.com/defunkt/cheat). However instead of using a full server to store the sheets, it uses github as central repository, making more reliable and easy to add new ones.
@@ -9,8 +11,9 @@ This gem is not a fork but inspired by [defunkt/cheat](https://github.com/defunk
 Submit a PR, adding a file to `sheets` folder, with the cheat-sheet name.
 
 1. Fork it
-2. `cheatly new name` (replacing name with name of the sheet)
-3. Create new Pull Request
+1. `cheatly create name` (replacing name with name of the sheet)
+1. `cheatly show --local NAME` to test your new sheet
+1. Create new Pull Request
 
 ## Installation
 
@@ -38,6 +41,16 @@ Submit a PR, adding a file to `sheets` folder, with the cheat-sheet name.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Build from source
+
+Building from source will allow you to test changes to your code locally before pushing it back to origin.
+
+1. `git clone https://github.com/arthurnn/cheatly.git`
+2. `cd cheatly`
+3. `bundle exec rake install`
+
+Repeat steps 3-4 to check modified code.
+
 
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/arthurnn/cheatly/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 

data/Rakefile

@@ -1 +1,13 @@
+#!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+desc 'Run tests'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/bin/cheatly

@@ -1,11 +1,4 @@
 #!/usr/bin/env ruby
-
-begin
-  require 'cheatly'
-rescue LoadError
-  require 'rubygems'
-  require 'cheatly'
-end
-
-c = Cheatly::CLI.new(ARGV)
-c.process
+$:.unshift File.expand_path("../../lib", __FILE__)
+require 'cheatly/cli'
+Cheatly::CLI.start

data/cheatly.gemspec

@@ -18,9 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty", "~> 0.12.0"
+  spec.add_dependency "octokit", "~> 2.6.1"
   spec.add_dependency "pager", "~> 1.0.1"
+  spec.add_dependency "thor", "~> 0.18.1"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", ">= 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0.8"
 end

data/completion/README.md

@@ -0,0 +1,6 @@
+# cheatly shell completion
+
+To add autocompletion to your shell, look in this directory
+and copy appropriate script to your shell completion directory e.g. `/etc/bash_completion.d/` for `bash`
+or copy contents of the script to your shell initializer file.
+

data/completion/cheatly.bash

@@ -0,0 +1,17 @@
+_cheatly_complete() {
+    local cur prev commands lists
+    COMPREPLY=()
+    cur="${COMP_WORDS[COMP_CWORD]}"
+    prev="${COMP_WORDS[COMP_CWORD-1]}"
+    local IFS=$'\n'
+
+    if [ $COMP_CWORD -eq 1 ]; then
+        commands=`cheatly | sed -n 's/.* \$ cheatly \([a-z]*\).*$/\1/p'`
+        COMPREPLY=( $( compgen -W '${commands}' -- ${cur} ) )
+    elif [[ $COMP_CWORD -eq 2 && "$prev" == show ]]; then
+        lists=`cheatly list | sed -n 's/  \(.*\)$/\1/p'`
+        COMPREPLY=( $( compgen -W '${lists}' -- ${cur} ) )
+    fi
+}
+complete -F _cheatly_complete cheatly
+

data/lib/cheatly/adapter/file.rb

@@ -0,0 +1,31 @@
+require "tempfile"
+require "yaml"
+
+module Cheatly
+  module Adapter
+    class File
+      def find(name)
+        path = "sheets/#{name}.yml"
+        sheet_yaml = ::File.read(path)
+        yml = YAML.load(sheet_yaml).first
+        [yml.first, yml.last]
+      end
+
+      def all
+        Dir["sheets/*.yml"].map { |f| f.scan(/sheets\/(.*).yml/)[0][0] }
+      end
+
+      def create(name, body)
+        body = {name => body}.to_yaml
+        f = ::File.new("sheets/#{name}.yml", "w")
+        f.write(body)
+        f.close
+      end
+
+      def update(name, body)
+        ::File.delete("sheets/#{name}.yml")
+        create(name, body)
+      end
+    end
+  end
+end

data/lib/cheatly/adapter/github.rb

@@ -0,0 +1,29 @@
+require "base64"
+require "yaml"
+
+require "octokit"
+
+module Cheatly
+  module Adapter
+    class GitHub
+      FOLDER = 'sheets'
+      REPO = 'arthurnn/cheatly'
+
+      def find(path)
+        response = Octokit.contents(REPO, path: "#{FOLDER}/#{path}.yml")
+        sheet_yaml = Base64.decode64(response.content)
+        yml = YAML.load(sheet_yaml).first
+        [yml.first, yml.last]
+      end
+
+      def all
+        response = Octokit.contents(REPO, path: "#{FOLDER}")
+        response.map { |f| f.name.gsub(/\.[a-z]+\z/, '') }
+      end
+
+      def create
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/{cheatly.rb → cheatly/cli.rb}

@@ -1,45 +1,19 @@
-require "base64"
-require "json"
-require "tempfile"
-require "optparse"
+require "cheatly/version"
+require "cheatly/sheet"
+require "cheatly/adapter/file"
+require "cheatly/adapter/github"
 
-require "httparty"
 require "pager"
-
-require "cheatly/sheet"
-require "cheatly/version"
+require "thor"
 
 module Cheatly
-  class CLI
+  class CLI < Thor
     include Pager
 
-    def initialize(args)
-      @command = args.shift || "help"
-      @handle = args.first
-
-      if "help" == @command
-        @handle = @command
-        @command = "show"
-      end
-
-      @options = {}
-      op_parser = OptionParser.new do |opts|
-        opts.on("-l", "--local", "Run using local file system") do |v|
-          @options[:local] = v
-        end
-      end
-      op_parser.parse! args
-    end
+    class_option :local, type: :boolean, aliases: "-l", desc: "Run using local file system"
 
-    def model
-      if @options[:local]
-        Sheet.with_file_adapter
-      else
-        Sheet
-      end
-    end
-
-    def sheet(handle)
+    desc "show SHEET_NAME", "show a cheat sheet"
+    def show(handle)
       sheet = model.find(handle)
       unless sheet
         puts "Sheet not found, run 'cheatly list' to see the availables."
@@ -50,6 +24,7 @@ module Cheatly
       puts sheet.to_s
     end
 
+    desc "list sheets", "list all available sheets"
     def list
       sheets = model.all
       page
@@ -59,18 +34,35 @@ module Cheatly
       end
     end
 
+    desc "create SHEET_NAME", "create a new sheet cheat"
     def create(handle)
       sheet = Sheet.with_file_adapter.new(handle)
       sheet.body = write_to_tempfile(handle)
       sheet.save
     end
 
+    desc "edit SHEET_NAME", "edit an existent sheet cheat"
     def edit(handle)
       sheet = Sheet.with_file_adapter.find(handle)
       sheet.body = write_to_tempfile(handle, sheet.body)
       sheet.save
     end
 
+    desc "help", "help"
+    def help
+      show('help')
+    end
+
+    private
+
+    def model
+      if options[:local]
+        Sheet.with_file_adapter
+      else
+        Sheet
+      end
+    end
+
     def write_to_tempfile(title, body = nil)
       tempfile = Tempfile.new(title + '.yml')
       tempfile.write(body) if body
@@ -85,20 +77,5 @@ module Cheatly
     def editor
       ENV['VISUAL'] || ENV['EDITOR'] || "nano"
     end
-
-    def process
-      case @command
-      when "show"
-        sheet(@handle)
-      when "list"
-        list
-      when "new"
-        create(@handle)
-      when "edit"
-        edit(@handle)
-      else
-        puts "Command [#{@command}] not found :-( . You can try running 'cheatly list' to check the available commands. "
-      end
-    end
   end
 end

data/lib/cheatly/sheet.rb

@@ -30,8 +30,8 @@ module Cheatly
     def self.find(handle)
       t, b = adapter.find(handle)
       Sheet.new(t, b, persisted: true)
-    rescue ## TODO: this is bad, fix me
-      nil
+    rescue RuntimeError => e
+      puts e.message
     end
 
     def self.all
@@ -40,11 +40,11 @@ module Cheatly
     end
 
     def self.adapter
-      @adapter ||= GithubAdapter.new
+      @adapter ||= Cheatly::Adapter::GitHub.new
     end
 
     def self.with_file_adapter
-      @adapter = FileAdapter.new
+      @adapter = Cheatly::Adapter::File.new
       self
     end
 
@@ -54,60 +54,4 @@ module Cheatly
         self.class.adapter
       end
   end
-
-  class FileAdapter
-    def find(name)
-      path = "sheets/#{name}.yml"
-      sheet_yaml = File.read(path)
-      yml = YAML.load(sheet_yaml).first
-      [yml.first, yml.last]
-    end
-
-    def all
-      Dir["sheets/*.yml"].map { |f| f.scan(/sheets\/(.*).yml/)[0][0] }
-    end
-
-    def create(name, body)
-      body = {name => body}.to_yaml
-      f = File.new "sheets/#{name}.yml", "w"
-      f.write(body)
-      f.close
-    end
-
-    def update(name, body)
-      File.delete "sheets/#{name}.yml"
-      create(name, body)
-    end
-  end
-
-  class GithubAdapter
-    include HTTParty
-    base_uri 'https://api.github.com'
-
-    def headers
-      { :headers => {"User-Agent" => "Cheatly Gem"} }
-    end
-
-    def base_path
-      "/repos/arthurnn/cheatly/contents/sheets"
-    end
-
-    def find(path)
-      response = self.class.get("#{base_path}/#{path}.yml", headers)
-      json = JSON.parse(response.body)
-      sheet_yaml = Base64.decode64(json["content"])
-      yml = YAML.load(sheet_yaml).first
-      [yml.first, yml.last]
-    end
-
-    def all
-      response = self.class.get(base_path, headers)
-      json = JSON.parse(response.body)
-      json.map { |entry| entry["name"].gsub('.yml', '') }
-    end
-
-    def create
-      raise NotImplementedError
-    end
-  end
 end

data/lib/cheatly/version.rb

@@ -1,3 +1,3 @@
 module Cheatly
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/sheets/help.yml

@@ -1,6 +1,18 @@
 ---
-help: ! "cheatly help\n------------\nusage: $ cheatly list\n       To list the available
-  sheets\n\n       $ cheatly show (sheetname)\n       To see the sheet\n\n       To
-  create a new sheet local:\n         1. Clone the project: https://github.com/arthurnn/cheatly\n
-  \        2. $ cheatly new (sheetname)\n         3. Create a PR\n\n       $ cheatly
-  help\n       To see this\n       happy cheating !\n"
+help: |
+  cheatly help
+  ------------
+  usage: $ cheatly list
+         To list the available sheets
+
+         $ cheatly show (sheetname)
+         To see the sheet
+
+         To create a new sheet local:
+           1. Clone the project: https://github.com/arthurnn/cheatly
+           2. $ cheatly create (sheetname)
+           3. Create a PR
+
+         $ cheatly help
+         To see this
+         happy cheating !

data/sheets/markdown.yml

@@ -0,0 +1,50 @@
+---
+markdown: |
+ Headings:
+
+   # h1      => <h1>h1</h1>
+   ## h2     => <h2>h2</h2>
+   ...
+   ###### h6 => <h6>h6</h6>
+
+ Paragraphs
+
+   Separate paragraphs with double newlines.  => <p>Separate paragraphs with double newlines.</p>
+
+   This is a second paragraph.                => <p>This is a second paragraph.
+   This is not a third paragraph.             => This is not a third paragraph.</p>
+
+ Blockquotes:
+                                  => <blockquote>
+   > This is a quote.             =>   <p>This is a quote. You can use multiple lines.</p>
+   > You can use multiple lines.  => </blockquote>
+
+ Code:
+
+   `code goes here` => <code>code goes here</code>
+
+  Lists:
+             =>   <ul>
+   * item 1  =>     <li>item 1</li>
+   * item 2  =>     <li>item 2</li>
+   * item 3  =>     <li>item 3</li>
+             =>   </ul>
+
+             =>   <ol>
+   1. item 1 =>     <li>item 1</li>
+   1. item 2 =>     <li>item 2</li>
+   1. item 3 =>     <li>item 3</li>
+             =>   </ol>
+
+ Inline:
+
+   *emphasis* => <em>emphasis</em>
+   **strong** => <strong>strong</strong>
+
+ Links:
+
+   [Text to display](http://example.com/)  => <a href='http://example.com'>Text to display</a>
+
+ Images:
+
+  ![alt text](/path/to/image.jpg)  => <img src='/path/to/image.jpg alt='alt text' />

data/test/sheet_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class SheetTest < MiniTest::Test
+  def test_sheet_find
+    sheet = Cheatly::Sheet.find("bash")
+    assert sheet
+  end
+
+  def test_sheet_list
+    sheets = Cheatly::Sheet.all
+    assert sheets.is_a?(Array)
+    assert sheets.any?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'cheatly/cli'
+require 'minitest/autorun'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cheatly
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Arthur Neves
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-01 00:00:00.000000000 Z
+date: 2013-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 2.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 2.6.1
 - !ruby/object:Gem::Dependency
   name: pager
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
 description: A cheat-sheet cli for a cheat repository
 email:
 - arthurnn@gmail.com
@@ -75,13 +103,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/cheatly
 - cheatly.gemspec
-- lib/cheatly.rb
+- completion/README.md
+- completion/cheatly.bash
+- lib/cheatly/adapter/file.rb
+- lib/cheatly/adapter/github.rb
+- lib/cheatly/cli.rb
 - lib/cheatly/sheet.rb
 - lib/cheatly/version.rb
 - sheets/assertions.yml
@@ -89,10 +122,13 @@ files:
 - sheets/exceptions.yml
 - sheets/gem_release.yml
 - sheets/help.yml
+- sheets/markdown.yml
 - sheets/migrations.yml
 - sheets/sprintf.yml
 - sheets/status_codes.yml
 - sheets/strftime.yml
+- test/sheet_test.rb
+- test/test_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -103,18 +139,20 @@ 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
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: A cheat-sheet cli for a cheat repository
-test_files: []
+test_files:
+- test/sheet_test.rb
+- test/test_helper.rb