cheatly 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODM2NTY4NjI1YjY0ZGY0MGQwNzAyOTFkMDJjOWY3OGUzMjU3OWM4OA==
+    ODNlNjlmZmE3MWEzNzQ0ZGEzNTE1MjdiODNkYTI2YmJkZmRhYTNjYg==
   data.tar.gz: !binary |-
-    NzNiM2JiYzA0MDczYTJiMjRkNzhmYzk3ZWVjODRhOTZiOWY3YmU5NQ==
+    NjM3ODU0M2FiNmNkMDI4YWY4NjgwN2IwOGQ3MDA1ZjYxZDAyY2NkNA==
 SHA512:
   metadata.gz: !binary |-
-    M2VhZGI5MWFmYTM1OTUwODRhODRmNDc3YTA0ZThlYzk4NDcxYTQ0NzhkOTRi
-    ZmM4NmZlYmM4MWY5ZmRmNDNlM2YyNjA2MTUzYzljNTgxMTA4MWJhYzI5NThk
-    M2IxZGNhNmVkNTY2YTM2ZTlhNDhmOGY1YzA0NzhhZjM4ZDM3MTQ=
+    ZjVkMWE2Mzg5Yjk4NjMyNmIxY2VmYTQ5MzIxNWJmZmUzYjkzYzUyMjg1NDlh
+    YWM5NTk2ZGFhMjkyNzc4NGU4ZjA1Nzc3Yzc0YjVmYjVkOTUxMDJhMmFlZDU5
+    ZjllNmZkZTJlOTE0MDJjNjZjYWFiNzAxMjU3OGY1MjRjYzFmYjQ=
   data.tar.gz: !binary |-
-    ZTM3NmFmNWYxYjJlZjMzZTU4NmJlODk4OGU2MmUyOWQ3OGFmZWNhMDgzYTZl
-    OWNhZDUxYWMxYzNkMmM5OGUwMGM0Y2Y4YjhlNzQzZTdiNzc0NWQwZjdhMTli
-    MmY2YzA5ZDc4NTY5MGE2MGQ1ZTYzMWFlZjBhYmMwMzY2ODlhZTk=
+    YTliODk1ZGFhYzgyNjFhOGFmODQ0MDRhNjAyOTU1Y2IwYmUwZDczMTJhNDQ5
+    N2E1NTRjMjFkMmFlMGU5YTc1NmM2ZWM4MTZjYTMzZGRkNDA4NGU5MDY4OTE5
+    NjJmYzA0Y2RhODVlMTA3YzY2ZjQ2NjZhMTdlMTlkZDc3YzExYTc=

data/README.md

@@ -1,12 +1,17 @@
 # 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 inspired by https://github.com/defunkt/cheat.
 
-## Please, help. Adding a new cheat-sheet
+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.
+
+## Help: Adding a new cheat-sheet
 
 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
+
 ## Installation
 
     $ gem install cheatly

data/lib/cheatly/sheet.rb

@@ -6,13 +6,15 @@ module Cheatly
     end
 
     def to_s
-      " #{@body.gsub("\r",'').gsub("\n", "\n  ")}"
+      "  #{@body.gsub("\r",'').gsub("\n", "\n  ")}"
+    end
+
+    def self.create(title, body)
+      adapter.create(title, body)
     end
 
     def self.find(handle)
-      sheet_yaml = adapter.find("sheets/#{handle}.yml")
-      yml = YAML.load(sheet_yaml).first
-      t, b = yml.first, yml.last
+      t, b = adapter.find(handle)
       Sheet.new(t, b)
     end
 
@@ -22,14 +24,32 @@ module Cheatly
     end
 
     def self.adapter
-#      @adapter ||= FileAdapter.new
       @adapter ||= GithubAdapter.new
     end
+
+    def self.with_file_adapter
+      @adapter = FileAdapter.new
+      self
+    end
   end
 
   class FileAdapter
-    def find(path)
-      File.read(path)
+    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
   end
 
@@ -38,19 +58,25 @@ module Cheatly
     base_uri 'https://api.github.com'
 
     def base_path
-      "/repos/arthurnn/cheatly/contents"
+      "/repos/arthurnn/cheatly/contents/sheets"
     end
 
     def find(path)
-      response = self.class.get("#{base_path}/#{path}")
+      response = self.class.get("#{base_path}/#{path}.yml")
       json = JSON.parse(response.body)
-      Base64.decode64(json["content"])
+      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}/sheets")
+      response = self.class.get(base_path)
       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.2"
+  VERSION = "0.0.3"
 end

data/lib/cheatly.rb

@@ -1,5 +1,7 @@
 require "base64"
 require "json"
+require "tempfile"
+require "optparse"
 
 require "httparty"
 require "pager"
@@ -19,17 +21,33 @@ module Cheatly
         @handle = @command
         @commands = "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
+
+    def model
+      if @options[:local]
+        Sheet.with_file_adapter
+      else
+        Sheet
+      end
     end
 
     def sheet(handle)
-      sheet = Sheet.find(handle)
+      sheet = model.find(handle)
       page
       puts "#{sheet.title}:"
       puts sheet.to_s
     end
 
     def list
-      sheets = Sheet.all
+      sheets = model.all
       page
       puts "List of available cheat-sheets:"
       sheets.each do |sheet|
@@ -37,12 +55,36 @@ module Cheatly
       end
     end
 
+    def create(handle)
+      body = write_to_tempfile(handle)
+      Sheet.with_file_adapter.create(handle, body)
+    end
+
+    def write_to_tempfile(title, body = nil)
+      # god dammit i hate tempfile, this is so messy but i think it's
+      # the only way.
+      tempfile = Tempfile.new(title + '.yml')
+      tempfile.write(body) if body
+      tempfile.close
+      system "#{editor} #{tempfile.path}"
+      tempfile.open
+      body = tempfile.read
+      tempfile.close
+      body
+    end
+
+    def editor
+      ENV['VISUAL'] || ENV['EDITOR'] || "nano"
+    end
+
     def process
       case @command
       when "show"
         sheet(@handle)
       when "list"
         list
+      when "new"
+        create(@handle)
       else
         puts "Command [#{@command}] not found. :-("
       end

data/sheets/assertions.yml

@@ -0,0 +1,19 @@
+---
+assertions: ! "  # Credit: http://nubyonrails.com/articles/ruby-rails-test-rails-cheat-sheet\n
+  \ # Use 'cheat assert_raise' for more details\n  \n  # Standard Ruby Assertions\n
+  \ \n  assert                  boolean \n  assert_equal            expected, actual
+  \n  assert_raise            *args \n  assert_raises           *args, &block \n  assert_instance_of
+  \     klass, object \n  assert_nil              object \n  assert_kind_of          klass,
+  object \n  assert_respond_to       object, method \n  assert_match            pattern,
+  string \n  assert_same             expected, actual \n  assert_operator         object1,
+  operator, object2 \n  assert_nothing_raised   *args \n  assert_not_same         expected,
+  actual \n  assert_not_equal        expected, actual \n  assert_not_nil          object
+  \n  assert_no_match         regexp, string \n  assert_throws           expected_symbol,
+  &proc \n  assert_nothing_thrown   &proc \n  assert_in_delta         expected_float,
+  actual_float, delta \n  assert_send             send_array\n  \n  # Rails Assertions\n
+  \ \n  assert_response         type \n  assert_redirected_to    options = {} \n  assert_template
+  \        expected \n  assert_recognizes       expected_options, path, extras={}
+  \n  assert_generates        expected_path, options, defaults={}, extras = {} \n
+  \ assert_routing          path, options, defaults={}, extras={} \n  assert_tag              *opts
+  \n  assert_no_tag           *opts \n  assert_dom_equal        expected, actual \n
+  \ assert_dom_not_equal    expected, actual \n  assert_valid            record "

data/sheets/bash.yml

@@ -0,0 +1,45 @@
+---
+bash: ! "     !! - Last command\n    !foo - Run most recent command starting with 'foo...'
+  (ex. !ps, !mysqladmin)\n    !foo:p - Print command that !foo would run, and add
+  it as the latest to\n    command history\n    !$ - Last 'word' of last command ('/path/to/file'
+  in the command 'ls -lAFh\n    /path/to/file', '-uroot' in 'mysql -uroot')\n    !$:p
+  - Print word that !$ would substitute\n    !* - All but first word of last command
+  ('-lAFh /path/to/file' in the\n    command 'ls -lAFh /path/to/file', '-uroot' in
+  'mysql -uroot')\n    !*:p - Print words that !* would substitute\n  \n    ^foo^bar
+  - Replace 'foo' in last command with 'bar', print the result, then\n    run. ('mysqladmni
+  -uroot', run '^ni^in', results in 'mysqladmin -uroot')\n  \n    {a,b,c} passes words
+  to the command, substituting a, b, and c sequentially\n    (`cp file{,.bk}` runs
+  `cp file file.bk`)\n  \n    Ctrl + a - Jump to the start of the line\n    Ctrl +
+  b - Move back a char\n    Ctrl + c - Terminate the command\n    Ctrl + d - Delete
+  from under the cursor\n    Ctrl + e - Jump to the end of the line\n    Ctrl + f
+  - Move forward a char\n    Ctrl + k - Delete to EOL\n    Ctrl + l - Clear the screen\n
+  \   Ctrl + r - Search the history backwards\n    Ctrl + R - Search the history backwards
+  with multi occurrence\n    Ctrl + t - Transpose the current char with the previous\n
+  \   Ctrl + u - Delete backward from cursor\n    Ctrl + w - Delete backward a word\n
+  \   Ctrl + xx - Move between EOL and current cursor position\n    Ctrl + x @ - Show
+  possible hostname completions\n    Ctrl + z - Suspend/ Stop the command\n    Ctrl
+  + x; Ctrl + e - Edit line into your favorite editor\n  \n    Alt + < - Move to the
+  first line in the history\n    Alt + > - Move to the last line in the history\n
+  \   Alt + ? - Show current completion list\n    Alt + * - Insert all possible completions\n
+  \   Alt + / - Attempt to complete filename\n    Alt + . - Yank last argument to
+  previous command\n    Alt + b - Move backward\n    Alt + c - Capitalize the word\n
+  \   Alt + d - Delete word\n    Alt + f - Move forward\n    Alt + l - Make word lowercase\n
+  \   Alt + n - Search the history forwards non-incremental\n    Alt + p - Search
+  the history backwards non-incremental\n    Alt + r - Recall command\n    Alt + t
+  - Transpose the current word with the previous\n    Alt + u - Make word uppercase\n
+  \   Alt + back-space - Delete backward from cursor\n  \n    (Here \"2T\" means Press
+  TAB twice)\n    $ 2T - All available commands(common)\n    $ (string)2T - All available
+  commands starting with (string)\n    $ /2T - Entire directory structure including
+  Hidden one\n    $ (dir)2T - Only Sub Dirs inside (dir) including Hidden one\n    $
+  *2T - Only Sub Dirs inside without Hidden one \n    $ ~2T - All Present Users on
+  system from \"/etc/passwd\"\n    $ $2T - All Sys variables\n    $ @2T - Entries
+  from \"/etc/hosts\"\n    $ =2T - Output like ls or dir\n    .bash_profile = sourced
+  by login shell, \n    .bashrc = sourced by all shells, \n    .bash_aliases = should
+  be sourced by .bashrc\n  \n  Run something:\n    for i in a b c; do $i 'hello';
+  done\n  \n  Do something on a bunch of files:\n    for i in *.rb; do echo \"$i\";
+  done\n  \n  If syntax:\n    if [[ -e .ssh ]]; then echo \"hi\"; fi\n  \n  Numerical
+  comparison:\n    i=0; if (( i <= 1 )); then echo \"smaller or equal\"; else echo
+  \"bigger\"; fi\n  \n  file check flags:\n    -e:  file exists\n    -f:  regular
+  file (non directory)\n    -d:  directory\n    -s:  non-zero file\n    -x:  execute
+  permission\n  \n  Avoid duplicates in your history:\n    export HISTIGNORE=\"&:ls:ls
+  *:[bf]g:exit\"\n  \n  more here:\n   \n    http://www.linuxtopia.org/online_books/advanced_bash_scripting_guide/fto.html"

data/sheets/exceptions.yml

@@ -0,0 +1,10 @@
+---
+exceptions: ! " Exception\r\n  NoMemoryError\r\n  ScriptError\r\n    LoadError\r\n    NotImplementedError\r\n
+  \    SyntaxError\r\n  SignalException\r\n    Interrupt\r\n      Timeout::Error    #
+  require 'timeout' for Timeout::Error\r\n  StandardError         # caught by rescue
+  if no type is specified\r\n    ArgumentError\r\n    IOError\r\n      EOFError\r\n    IndexError\r\n
+  \    LocalJumpError\r\n    NameError\r\n      NoMethodError\r\n    RangeError\r\n      FloatDomainError\r\n
+  \    RegexpError\r\n    RuntimeError\r\n      Timeout::Error    # moved here in ruby
+  1.9.2\r\n    SecurityError\r\n    SocketError\r\n    SystemCallError     # Errno::*
+  inherits here\r\n    SystemStackError\r\n    ThreadError\r\n    TypeError\r\n    ZeroDivisionError\r\n
+  \  SystemExit\r\n  fatal"

data/sheets/migrations.yml

@@ -0,0 +1,63 @@
+---
+migrations: ! "  Methods:\n    create_table(name, options)\n    drop_table(name)\n
+  \   rename_table(old_name, new_name)\n    add_column(table_name, column_name, type,
+  options)\n    rename_column(table_name, column_name, new_column_name)\n    change_column(table_name,
+  column_name, type, options)\n    remove_column(table_name, column_name)\n    add_index(table_name,
+  column_name, index_type)\n    remove_index(table_name, column_name)\n    change_table(table_name)
+  {|Table.new(table_name, self)| ...} \n  \n  Available Column Types (mappings are
+  below):\n    * integer\n    * float\n    * datetime\n    * date\n    * timestamp\n
+  \   * time\n    * text\n    * string\n    * binary\n    * boolean\n    * decimal
+  :precision, :scale\n  \n  Valid Column Options:\n    * limit\n    * null (i.e. \":null
+  => false\" implies NOT NULL)\n    * default (to specify default values)\n    * :decimal,
+  :precision => 8, :scale => 3\n  \n  Rake Tasks:\n    rake db:schema:dump: run after
+  you create a model to capture the schema.rb\n    rake db:schema:import: import the
+  schema file into the current database (on\n    error, check if your schema.rb has
+  \":force => true\" on the create table\n    statements\n    ./script/generate migration
+  MigrationName: generate a new migration with a\n    new 'highest' version (run './script/generate
+  migration' for this info at\n    your fingertips)\n    rake db:migrate: migrate
+  your current database to the most recent version\n    rake db:migrate VERSION=5:
+  migrate your current database to a specific\n    version (in this case, version
+  5)\n    rake db:rollback: migrate down one migration\n    rake db:rollback STEP=3:
+  migrate down three migrations\n    rake db:migrate RAILS_ENV=production: migrate
+  your production database\n  \n  SQL:\n    Queries can be executed directly:\n    execute
+  'ALTER TABLE researchers ADD CONSTRAINT fk_researchers_departments\n    FOREIGN
+  KEY ( department_id ) REFERENCES departments( id )'\n  \n  Example Migration:\n
+  \   class UpdateUsersAndCreateProducts < ActiveRecord::Migration\n      def self.up\n
+  \       rename_column \"users\", \"password\", \"hashed_password\" \n        remove_column
+  \"users\", \"email\" \n  \n        User.reset_column_information\n        User.find(:all).each{|u|
+  #do something with u}\n  \n        create_table \"products\", :force => true do
+  |t|\n          t.column \"name\", :text\n          t.column \"description\", :text\n
+  \         t.column \"price\", :decimal, :precision => 9, :scale => 2\n          t.column
+  \"category_id\", :integer\n        end\n  \n        #the rails 2.0 way:\n        create_table
+  :people do |t|\n          t.integer :account_id\n          t.string  :first_name,
+  :last_name, :null => false\n          t.text    :description\n          t.references
+  :category # is the equivalent of t.integer :category_id\n          t.timestamps\n
+  \       end\n      end\n  \n      def self.down\n        rename_column \"users\",
+  \"hashed_password\", \"password\" \n        add_column \"users\", \"email\", :string\n
+  \       drop_table \"products\" \n      end\n    end\n  \n  Find Highest version:\n
+  \   script/runner \"puts ActiveRecord::Migrator.current_version\"\n  \n  Database
+  Mapping\n  \n  Rails      | db2          | mysql        | openbase     | Oracle
+  \       |\n  ---        | ---          | ---          | ---          | ---           |\n
+  \ :binary    | blob(32678)  | blob         | object       | blob          |\n  :boolean
+  \  | decimal(1)   | tinyint(1)   | boolean      | number(10)    |\n  :date      |
+  date         | date         | date         | date          |\n  :datetime  | timestamp
+  \   | datetime     | datetime     | date          |\n  :decimal   | decimal      |
+  decimal      | decimal      | decimal       |\n  :float     | float        | float
+  \       | float        | number        |\n  :integer   | int          | int(11)
+  \     | integer      | number(38)    |\n  :string    | varchar(255) | varchar(255)
+  | char(4096)   | varchar2(255) |\n  :text      | clob(32768)  | text         | text
+  \        | clob          |\n  :time      | time         | time         | time         |
+  date          |\n  :timestamp | timestamp    | datetime     | timestamp    | date
+  \         |\n  \n  Rails      | postgresql   | sqlite       | sqlserver    | Sybase
+  \       |\n  ---        | ---          | ---          | ---          | ---           |\n
+  \ :binary    | bytea        | blob         | image        | image         |\n  :boolean
+  \  | boolean      | boolean      | bit          | bit           |\n  :date      |
+  date         | date         | datetime     | datetime      |\n  :datetime  | timestamp
+  \   | datetime     | datetime     | datetime      |\n  :decimal   | decimal      |
+  decimal      | decimal      | decimal       |\n  :float     | float        | float
+  \       | float(8)     | float(8)      |\n  :integer   | integer      | integer
+  \     | int          | int           |\n  :string    | *            | varchar(255)
+  | varchar(255) | varchar(255)  |\n  :text      | text         | text         | text
+  \        | text          |\n  :time      | time         | datetime     | datetime
+  \    | time          |\n  :timestamp | timestamp    | datetime     | datetime     |
+  timestamp     |"

data/sheets/sprintf.yml

@@ -0,0 +1,11 @@
+---
+sprintf: ! "  %b    => Binary integer\n %c    => Single character\n %d    => Decimal
+  integer\n %e    => Decimal integer displayed in exponential form (3e+07)\n %E
+  \   => Decimal integer displayed in exponential form (3E+07)\n %f    => Floating
+  point number\n %g    => Same as %e if exponent is less than -4, %f otherwise\n %G
+  \    => Same as %E if exponent is less than -4, %f otherwise\n %o    => Octal
+  integer\n %s    => String\n %u    => Unsigned decimal integer\n %x    => Hexadecimal
+  integer (2a)\n %X    => Hexadecimal integer uppercase (2A)\n %02d  => 0 padded
+  two digits\n %.02f => round to the hundredths\n %+    => +/- sign\n \n width
+  & alignment\n \"%10s\" % \"hello\" => \"     hello\"    \n \"%-10s\" % \"hello\"
+  => \"hello     \""

data/sheets/status_codes.yml

@@ -0,0 +1,20 @@
+---
+status_codes: ! "  Use these codes for the #head or #render methods.  ex:\n    head
+  :ok\n    render :file => '404.html.erb', :status => :not_found\n  \n  1xx Informational\n
+  \ \n  100 => :continue\n  101 => :switching_protocols\n  102 => :processing\n  \n
+  \ 2xx Success\n  \n  200 => :ok\n  201 => :created\n  202 => :accepted\n  203 =>
+  :non_authoritative_information\n  204 => :no_content\n  205 => :reset_content\n
+  \ 206 => :partial_content\n  207 => :multi_status\n  226 => :im_used\n  \n  3xx
+  Redirection\n  \n  300 => :multiple_choices\n  301 => :moved_permanently\n  302
+  => :found\n  303 => :see_other\n  304 => :not_modified\n  305 => :use_proxy\n  307
+  => :temporary_redirect\n  \n  4xx Client Error\n  \n  400 => :bad_request\n  401
+  => :unauthorized\n  402 => :payment_required\n  403 => :forbidden\n  404 => :not_found\n
+  \ 405 => :method_not_allowed\n  406 => :not_acceptable\n  407 => :proxy_authentication_required\n
+  \ 408 => :request_timeout\n  409 => :conflict\n  410 => :gone\n  411 => :length_required\n
+  \ 412 => :precondition_failed\n  413 => :request_entity_too_large\n  414 => :request_uri_too_long\n
+  \ 415 => :unsupported_media_type\n  416 => :requested_range_not_satisfiable\n  417
+  => :expectation_failed\n  422 => :unprocessable_entity\n  423 => :locked\n  424
+  => :failed_dependency\n  426 => :upgrade_required\n  \n  5xx Server Error\n  \n
+  \ 500 => :internal_server_error\n  501 => :not_implemented\n  502 => :bad_gateway\n
+  \ 503 => :service_unavailable\n  504 => :gateway_timeout\n  505 => :http_version_not_supported\n
+  \ 507 => :insufficient_storage\n  510 => :not_extended"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cheatly
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Arthur Neves
@@ -84,7 +84,13 @@ files:
 - lib/cheatly.rb
 - lib/cheatly/sheet.rb
 - lib/cheatly/version.rb
+- sheets/assertions.yml
+- sheets/bash.yml
+- sheets/exceptions.yml
 - sheets/gem_release.yml
+- sheets/migrations.yml
+- sheets/sprintf.yml
+- sheets/status_codes.yml
 - sheets/strftime.yml
 homepage: ''
 licenses: