code2gist 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    code2gist (0.0.2)
+    code2gist (0.0.3)
 
 GEM
   specs:

data/README.md

@@ -1,12 +1,17 @@
 # code2gist
 
-This library parses text and looks for this pattern:
+This library looks for code blocks in your text and uploads them to
+http://gist.github.com. Then, it can either give you the link to it or
+replace your code blocks inline for their respective gist.github.com
+links.
+
+The code must follow this pattern:
 
     ```filename.extension
     some code
     ```
 
-It uploads all matches to http://gist.github.com and returns the link to it. The filename and extension are optional — it'll assume it's an untitled plain text file if you don't specify what it is.
+The filename and extension are optional — it'll assume it's an untitled plain text file if you don't specify what it is.
 
 ## Usage
 
@@ -15,26 +20,23 @@ It's very simple:
     require 'code2gist'
     Code2Gist.upload(your_text, "example description")
 
-### Options
-It supports a couple of boolean options:
+Or:
 
-- `:embed` (default: `false`)
-- `:html` (default: `false`)
+    new_text = Code2Gist.replace(your_text, "another example description")
 
-Quick example:
+### Options
+When replacing, there is one option available: `:html` (default:
+`false`).
 
-    Code2Gist.upload(your_markdown_text, "another description", :embed => true, :html => true)
+Quick example:
 
-If you pass `:embed => true`to it, it will replace all code blocks with
-links to the appropriate file at http://gist.github.com. If you also
-pass `:html => true`, it will replace all code blocks with embeded
-gists.
+    Code2Gist.replace(your_markdown_text, "yad", :html => true)
 
-This is specially useful if your using markdown/textile and would like
+This is specially useful if you're using markdown/textile and would like
 to have all your code blocks in a gist and embeded in your HTML. For
 example:
 
-    html = Markdown.new(Code2Gist.upload(text, "Article code snippets", :embed => true, :html => true)).to_html
+    html = Markdown.new(Code2Gist.replace(text, "Code snippets from article X", :html => true)).to_html
 
 ### I want to be the owner of the gist!
 
@@ -48,7 +50,15 @@ gists:
 
 Use `code2gist`from the command-line. Just run:
 
-    code2gist file "optional description"
+    $ code2gist upload file "optional description"
+
+Or:
+
+    $ code2gist replace file "optional description"
+
+Or even:
+
+    $ code2gist replace file "optional description" --substitute # this will change your file in place!
 
 It supports all options. Check `code2gist --help` to see how to use them
 properly.
@@ -77,7 +87,7 @@ properly.
 
     Code2Gist.upload(code, "my description) # => https://gist.github.com/1157214
 
-    Code2Gist.upload(code, "another description", :embed => true) # =>
+    Code2Gist.replace(code, "another description") # =>
     #  This is just a regular `document`
     #
     #  It can have code!
@@ -89,7 +99,7 @@ properly.
     #
     #  The end
 
-    Code2Gist.upload(code, "yet another description", :embed => true, :html => true) # =>
+    Code2Gist.replace(code, "yet another description", :html => true) # =>
     #  This is just a regular `document`
     #
     #  It can have code!

data/bin/code2gist

@@ -5,16 +5,19 @@ require "code2gist"
 
 options = {}
 OptionParser.new do |opt|
-  opt.banner = "Usage: code2gist file [description] [OPTS]"
-  opt.on('-e', '--embed', 'Embed links to the code', "Default: false") { |e| options[:embed] = e }
-  opt.on('-h', '--html', 'Assume it\'s HTML. Use this in combination with --embed.', "Default: false") { |h| options[:html] = h }
+  opt.banner = "Usage: code2gist [upload|replace] file [description] [OPTS]"
+  opt.on('-h', '--html', 'Assume it\'s HTML when replacing', "Default: false") { |h| options[:html] = h }
+  opt.on('-s', '--substitute', 'Replace the contents of the original file', "Default: false") { |s| options[:substitute] = s }
   opt.on('-l', '--login LOGIN', String, 'Your GitHub login (to be the owner of the gist)') { |l| options[:login] = l }
   opt.on('-t', '--token TOKEN', String, 'Your GitHub api token (to be the owner of the gist)') { |t| options[:token] = t }
   opt.parse!(ARGV)
 end
 
-path = ARGV[0]
-description = ARGV[1] || ""
+action = ARGV[0]
+$stderr.puts "You must specify a valid action: upload or replace. `code2gist --help` for more information." unless ["upload", "replace"].include?(action)
+
+path = ARGV[1]
+description = ARGV[2] || ""
 
 if path.nil? || !File.exists?(path)
   $stderr.puts "You must specify a valid file to read from"
@@ -23,10 +26,22 @@ end
 
 login = options.delete(:login)
 token = options.delete(:token)
+substitute = options.delete(:substitute)
 
 if login && options
   Code2Gist::Config.github_login = login
   Code2Gist::Config.github_token = token
 end
 
-puts Code2Gist.upload(File.read(path), description, options)
+if action == "upload"
+  puts Code2Gist.upload(File.read(path), description)
+elsif action == "replace"
+  new_text = Code2Gist.replace(File.read(path), description, options)
+
+  if substitute
+    File.open(path, 'w') { |f| f.write(new_text) }
+  else
+    puts new_text
+  end
+end
+

data/code2gist.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name              = "code2gist"
-  s.version           = "0.0.2"
+  s.version           = "0.0.3"
   s.platform          = Gem::Platform::RUBY
   s.authors           = ["Gonçalo Silva"]
   s.email             = ["goncalossilva@gmail.com"]

data/lib/code2gist.rb

@@ -4,6 +4,8 @@ require "json"
 
 module Code2Gist
   extend self
+  
+  CODE_REGEX = /```(\w+\.\w+)?[^\n]*\n(.*?)```/m
 
   module Config
     def self.github_login
@@ -20,28 +22,29 @@ module Code2Gist
     end
   end
 
-  def upload(text, description = nil, opts = {})
-    options = {:embed => false, :html => false}.merge(opts)
-
-    code_regex = /```(\w+\.\w+)?[^\n]*\n(.*?)```/m
+  def upload(text, description = nil)
     new_text = name_nameless_code_blocks(text)
 
-    code_blocks = Hash[*new_text.scan(code_regex).flatten]
-    
+    code_blocks = Hash[*new_text.scan(CODE_REGEX).flatten]
+
     if code_blocks.empty?
-      return "No code blocks found"
+      return nil
     end
 
-    gist_url = get_gist(code_blocks, description)
+    get_gist(code_blocks, description)
+  end
 
-    if options[:embed]
-      if options[:html]
-        new_text.gsub(code_regex, "<script src=\"#{gist_url}.js?file=\\1\"></script>")
-      else
-        new_text.gsub(code_regex, "#{gist_url}?file=\\1")
-      end
+  def replace(text, description = nil, opts = {})
+    options = {:html => false}.merge(opts)
+
+    new_text = name_nameless_code_blocks(text)
+
+    gist_url = upload(new_text, description)
+
+    if options[:html]
+      new_text.gsub(CODE_REGEX, "<script src=\"#{gist_url}.js?file=\\1\"></script>")
     else
-      gist_url
+      new_text.gsub(CODE_REGEX, "#{gist_url}?file=\\1")
     end
   end
 

data/test/code2gist_test.rb

@@ -32,10 +32,10 @@ class Code2GistTest < Test::Unit::TestCase
 
     assert Code2Gist.upload(code, "test description") =~ /https:\/\/gist\.github\.com\/\d+/
 
-    assert Code2Gist.upload(code, "another description", :embed => true) =~ /https:\/\/gist.github.com\/\d+\?file=\w+\.\w+/
+    assert Code2Gist.replace(code, "another description") =~ /https:\/\/gist.github.com\/\d+\?file=\w+\.\w+/
 
-    assert Code2Gist.upload(code, "yet another description", :embed => true, :html => true) =~ /<script src="https:\/\/gist.github.com\/\d+\.js\?file=\w+\.\w+"><\/script>/
+    assert Code2Gist.replace(code, "yet another description", :html => true) =~ /<script src="https:\/\/gist.github.com\/\d+\.js\?file=\w+\.\w+"><\/script>/
 
-    assert Code2Gist.upload(nocode, "no code!") == "No code blocks found"
+    assert Code2Gist.replace(nocode, "no code!") == nocode
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code2gist
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -42,7 +42,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4231852110147090976
+      hash: 3355642002282232388
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: