cheatly 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32818231558e1e9a89f45882f281f5c462842e31
-  data.tar.gz: 910657b9200ab0887056f9f16595062435b799c6
+  metadata.gz: 22a95708a0ba7e2cd6ae42d96ccb21f5831f625b
+  data.tar.gz: 72ef8506ad5d566176224a1b46bb0320e7e831d8
 SHA512:
-  metadata.gz: 8421f12bdc98568b06cc20c8781a2c08505de2611b70034f970db0a53dd0505d7420811fe68ae659edbb42fb55250f5f517c2b12bbd9b14d9c34fd3c89c6f409
-  data.tar.gz: 6b31f06c615b0930ae1941dc9765c8938bd3d80998f0ccafd589d3d674c3452e706863e6f7f4c7e7490c988dbaee5f6514b42400f02a720622c86a45d32a1271
+  metadata.gz: 119a38f79205a13aaed68d23659eac99c361e458b31c5d029320e256ab7c0c1a7cf1e05541620e7ef7efc9fb9a1519fead2304099ec39a0f74a357d636c737e5
+  data.tar.gz: 3a08fe096011cdf93edd25a45e715d528039c14c2a09d99fcc41fca4e8b7e24939f20f45447ebdbef5df59c846adbb1b2b1347d001da83ac6c7827c9d37bc7af

data/lib/cheatly/adapter/file.rb

@@ -1,5 +1,4 @@
 require "tempfile"
-require "yaml"
 
 module Cheatly
   module Adapter
@@ -14,7 +13,6 @@ module Cheatly
       end
 
       def create(name, body)
-        body = {name => body}.to_yaml
         f = ::File.new("sheets/#{name}.md", "w")
         f.write(body)
         f.close

data/lib/cheatly/adapter/github.rb

@@ -1,6 +1,4 @@
 require "base64"
-require "yaml"
-
 require "octokit"
 
 module Cheatly
@@ -19,7 +17,11 @@ module Cheatly
         response.map { |f| f.name.gsub(/\.[a-z]+\z/, '') }
       end
 
-      def create
+      def create(name, body)
+        raise NotImplementedError
+      end
+
+      def update(name, body)
         raise NotImplementedError
       end
     end

data/lib/cheatly/cli.rb

@@ -15,6 +15,8 @@ module Cheatly
 
     class_option :local, type: :boolean, aliases: "-l", desc: "Run using local file system"
 
+    class_option :nopaginate, type: :boolean, desc: "Disable pagination"
+
     desc "show SHEET_NAME", "show a cheat sheet"
     def show(handle)
       sheet = model.find(handle)
@@ -22,7 +24,7 @@ module Cheatly
         puts "Sheet not found, run 'cheatly list' to see the availables."
         return
       end
-      page
+      page unless options[:nopaginate]
       renderer = Renderer.new
       md = Redcarpet::Markdown.new(renderer, no_intra_emphasis: true)
       puts md.render(sheet.to_s)
@@ -31,7 +33,7 @@ module Cheatly
     desc "list sheets", "list all available sheets"
     def list
       sheets = model.all
-      page
+      page unless options[:nopaginate]
       puts "List of available cheat-sheets:"
       sheets.each do |sheet|
         puts "  #{sheet.title}"
@@ -40,14 +42,14 @@ module Cheatly
 
     desc "create SHEET_NAME", "create a new sheet cheat"
     def create(handle)
-      sheet = Sheet.with_file_adapter.new(handle)
+      sheet = LocalSheet.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 = LocalSheet.find(handle)
       sheet.body = write_to_tempfile(handle, sheet.body)
       sheet.save
     end
@@ -67,14 +69,14 @@ module Cheatly
 
       def model
         if options[:local]
-          Sheet.with_file_adapter
+          LocalSheet
         else
           Sheet
         end
       end
 
       def write_to_tempfile(title, body = nil)
-        tempfile = Tempfile.new(title + '.yml')
+        tempfile = Tempfile.new(title + '.md')
         tempfile.write(body) if body
         tempfile.close
         system "#{editor} #{tempfile.path}"

data/lib/cheatly/renderer.rb

@@ -17,11 +17,13 @@ module Cheatly
     end
 
     def header(title, level)
-      sep = case level
-      when 1 then '='
-      when 2 then '+'
-      when 3 then '-'
-      end
+      sep =
+        case level
+        when 1 then '='
+        when 2 then '+'
+        when 3 then '-'
+        else ''
+        end
 
       "\n#{title.bold}\n#{(sep * title.length).bold}\n"
     end

data/lib/cheatly/sheet.rb

@@ -1,6 +1,6 @@
 module Cheatly
   class Sheet
-    attr_accessor :title, :body
+    attr_accessor :title, :body, :persisted
 
     def initialize(title, body = nil, options = {})
       @title, @body = title, body
@@ -13,6 +13,7 @@ module Cheatly
 
     def create
       adapter.create(title, body)
+      @persisted = true
     end
 
     def update
@@ -29,8 +30,9 @@ module Cheatly
 
     def self.find(name)
       body = adapter.find(name)
-      Sheet.new(name, body, persisted: true)
-    rescue Octokit::NotFound => e
+      self.new(name, body, persisted: true)
+    rescue Octokit::NotFound, Octokit::TooManyRequests
+      puts "Octokit error."
       nil
     rescue RuntimeError => e
       puts e.message
@@ -45,15 +47,16 @@ module Cheatly
       @adapter ||= Cheatly::Adapter::GitHub.new
     end
 
-    def self.with_file_adapter
-      @adapter = Cheatly::Adapter::File.new
-      self
-    end
-
     private
 
       def adapter
         self.class.adapter
       end
   end
+
+  class LocalSheet < Sheet
+    def self.adapter
+      @adapter ||= Cheatly::Adapter::File.new
+    end
+  end
 end

data/lib/cheatly/version.rb

@@ -1,3 +1,3 @@
 module Cheatly
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/sheets/gpg.md

@@ -0,0 +1,36 @@
+# GPG
+
+## Encrypt/Decrypt data
+### To encrypt data:
+  gpg -e -u "Sender User Name" -r "Receiver User Name" somefile
+
+### To decrypt data:
+  gpg -d mydata.tar.gpg
+
+## Keys manipulation
+### Create a key:
+  gpg --gen-key
+
+### Export a key:
+  gpg --export -a "User Name" > public.key
+
+### Export a private key:
+  gpg --export-secret-key -a "User Name" > private.key
+
+### Import a friend's public key:
+  gpg --import public.key
+
+### Import a private key:
+  gpg --allow-secret-key-import --import private.key
+
+### Delete a public key:
+  gpg --delete-key "User Name"
+
+### Delete a private key:
+  gpg --delete-secret-key "User Name"
+
+### To list the keys in your public key ring:
+  gpg --list-keys
+
+### To list the keys in your secret key ring:
+  gpg --list-secret-keys

data/sheets/{markdown.yml → markdown.md}

@@ -1,30 +1,30 @@
----
-markdown: |
- Headings:
+# markdown
+
+## Headings:
 
    # h1      => <h1>h1</h1>
    ## h2     => <h2>h2</h2>
    ...
    ###### h6 => <h6>h6</h6>
 
- Paragraphs
+## 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>
+## 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:
 
-   `code goes here` => <code>code goes here</code>
+  `code goes here` => <code>code goes here</code>
 
-  Lists:
-             =>   <ul>
+##  Lists:
+           =>   <ul>
    * item 1  =>     <li>item 1</li>
    * item 2  =>     <li>item 2</li>
    * item 3  =>     <li>item 3</li>
@@ -36,15 +36,15 @@ markdown: |
    1. item 3 =>     <li>item 3</li>
              =>   </ol>
 
- Inline:
+## Inline:
 
    *emphasis* => <em>emphasis</em>
    **strong** => <strong>strong</strong>
 
- Links:
+## Links:
 
    [Text to display](http://example.com/)  => <a href='http://example.com'>Text to display</a>
 
- Images:
+## Images:
 
   ![alt text](/path/to/image.jpg)  => <img src='/path/to/image.jpg alt='alt text' />

data/sheets/migrations.md

@@ -1,5 +1,9 @@
 # Rails Migrations
 
+## Generating a new migration
+
+  rails generate migration AddPartNumberToProducts
+
 ## Methods:
 
   create_table(name, options)

data/test/cli_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class CliTest < MiniTest::Test
+
+  def test_list
+    cli = Cheatly::CLI.new([], nopaginate: true)
+    cli.list
+
+    cli = Cheatly::CLI.new([], local: true, nopaginate: true)
+    cli.list
+  end
+
+  def test_show
+    cli = Cheatly::CLI.new([], nopaginate: true)
+    cli.show "help"
+  end
+
+  def test_help
+    cli = Cheatly::CLI.new([], nopaginate: true)
+    cli.help
+  end
+end

data/test/sheet_test.rb

@@ -8,11 +8,41 @@ class SheetTest < MiniTest::Test
   end
 
   def test_sheet_find
-    sheet = Cheatly::Sheet.find("bash")
-    assert sheet
+    assert Cheatly::Sheet.find("bash")
+    assert Cheatly::LocalSheet.find("bash")
   end
 
   def test_sheet_not_found
     assert_nil Cheatly::Sheet.find("foo")
   end
+
+  def test_write_sheet
+    sheet = Cheatly::Sheet.new("foo")
+    assert_raises(NotImplementedError) { sheet.save }
+
+    sheet = Cheatly::LocalSheet.new("foobar")
+    sheet.body = "foobar"
+    sheet.save
+
+    assert_nil Cheatly::Sheet.find("foobar")
+    assert Cheatly::LocalSheet.find("foobar")
+  ensure
+    FileUtils.rm "sheets/foobar.md"
+  end
+
+  def test_update_sheet
+    sheet = Cheatly::LocalSheet.new("bar")
+    sheet.body = "foo"
+    sheet.save
+
+    assert sheet.persisted
+
+    sheet.body = "foo"
+    sheet.save
+
+    assert sheet = Cheatly::LocalSheet.find("bar")
+    assert_equal "foo", sheet.body
+  ensure
+    FileUtils.rm "sheets/bar.md"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheatly
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Arthur Neves
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-11 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -150,11 +150,13 @@ files:
 - sheets/bash.md
 - sheets/exceptions.md
 - sheets/gem_release.md
+- sheets/gpg.md
 - sheets/help.md
-- sheets/markdown.yml
+- sheets/markdown.md
 - sheets/migrations.md
 - sheets/sprintf.md
 - sheets/status_codes.md
+- test/cli_test.rb
 - test/sheet_test.rb
 - test/test_helper.rb
 homepage: ''
@@ -182,5 +184,6 @@ signing_key:
 specification_version: 4
 summary: A cheat-sheet cli for a cheat repository
 test_files:
+- test/cli_test.rb
 - test/sheet_test.rb
 - test/test_helper.rb