starter 0.1.10 → 0.1.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cf370bea371d92e0f522c20dbdb1fd37be5d6b4
+  data.tar.gz: b5a31f123a9087458e318386bf04f9ec251aa136
+SHA512:
+  metadata.gz: c97531be24c2260bc15f0b9d8caf4687c66843ecf398bef46f84b82b93b66ed98631dcf902ddff21299cbfd50ba374a1f79a60bfe04c38db84e0235481d91fa8
+  data.tar.gz: 77b003f7d03ee93a905d364d9afe660dd688f5d154f39c00713768b359aa29529602df663625436086a63937c3b316e1a721c315d3b0c2ef94b546adef5448a1

data/lib/starter/markdown/extender.rb

@@ -0,0 +1,158 @@
+module Starter
+
+  class Markdown
+
+
+    #Extender.process(
+      #:file => "path/to/template.md",
+      #:output => "path/to/output.md"
+    #)
+    #new_string = Extender.process(string)
+
+    module Extender
+
+      def self.process(arg)
+        if arg.is_a? String
+          string = arg
+          options = {}
+        else
+          options = arg
+          string = File.read arg[:file]
+        end
+        lines = string.split("\n")
+        out = FootnoteProcessor.new.process(lines)
+        out = CodeEmbedder.new.process(out)
+
+        processed = out.join("\n")
+        if path = options[:output]
+          File.open path, "w" do |f|
+            f.puts processed
+          end
+        end
+        processed
+      end
+
+    end
+
+    class CodeEmbedder
+      def initialize(options={})
+        @regex = %r{^```([^\s#]+)(#L(\S+))?\s*```$}
+      end
+
+
+      def process(lines)
+        # TODO: handle URLs
+        out = []
+        lines.each do |line|
+          if md = @regex.match(line)
+            _full, source_path, badline, line_spec = md.to_a
+            if line_spec
+              start, stop = line_spec.split("-").map { |s| s.to_i}
+            else
+              start = 1
+            end
+
+            source_path = File.expand_path(source_path).strip
+            extension = File.extname(source_path)
+            out << "```#{extension}\n\n"
+
+            embed = []
+            File.open(source_path, "r") do |source|
+              source.each_line do |line|
+                embed << line
+              end
+            end
+            start -= 1
+            if stop
+              stop -=1
+            else
+              stop = embed.size - 1
+            end
+            out << embed.slice(start..stop).join()
+            out << "```\n"
+          else
+            out << line
+          end
+        end
+        out
+      end
+
+    end
+
+    # Converts Pandoc-style footnotes into appropriate HTML
+    class FootnoteProcessor
+
+      def initialize(options={})
+        # looking for footnote refs like [^some_identifier]
+        @note_regex = /
+          ^
+          \[\^
+            ([\d\w\-_]+)
+          \]:
+        /x
+        @ref_regex = /
+          \[\^
+            ([\d\w\-_]+)
+          \]
+        /x
+      end
+      
+      def process(lines)
+        out = []
+        refs = []
+        notes = {}
+        ref_counter = 0
+        while line = lines.shift
+          if md = @note_regex.match(line)
+            full, identifier = md.to_a
+            note = notes[identifier] = [line]
+            while (next_line = lines.shift) && next_line !~ /^\s*$/
+              note << next_line
+            end
+
+          elsif md = @ref_regex.match(line)
+            full, identifier = md.to_a
+            ref_counter += 1
+            refs << identifier
+            out << line.sub(full, format_ref(ref_counter, identifier))
+          else
+            out << line
+          end
+        end
+
+        if refs.size > 0
+          out << ""
+          out << "# Notes"
+          out << ""
+          refs.each_with_index do |identifier, index|
+            if note = notes[identifier]
+              start = note.shift
+              anchor = format_anchor(index + 1, identifier)
+              start.sub! /^\[.*\]: /, ""
+              out << "#{anchor} #{start}"
+
+              note.each do |line|
+                out << line
+              end
+              out << ""
+            end
+          end
+        end
+        out << ""
+        out
+      end
+
+
+      def format_anchor(number, identifier)
+        %Q{<a name="#{identifier}" href="#__#{identifier}">#{number} &#8617;</a>.}
+      end
+
+      def format_ref(number, identifier)
+        %Q{
+          <sup><a name="__#{identifier}" href="##{identifier}">#{number}</a>.</sup>
+        }.strip
+      end
+    end
+
+  end
+end

data/lib/starter/tasks/bootstrap.rb

@@ -1,14 +1,14 @@
 require "starter/tasks/starter"
 
-$STARTER[:directory] = File.basename(Dir.pwd)
-$STARTER[:gemspec_file] = "#{$STARTER[:directory]}.gemspec"
+Starter.cache[:directory] = File.basename(Dir.pwd)
+Starter.cache[:gemspec_file] = "#{Starter.cache[:directory]}.gemspec"
 
 desc "Bootstrap your project"
 task "bootstrap" => %w[ LICENSE ]
 
 file "LICENSE" => %w[ determine_author ] do
   File.open("LICENSE", "w") do |file|
-    file.puts mit_license(:author => $STARTER[:author])
+    file.puts mit_license(:author => Starter.cache[:author])
   end
 end
 

data/lib/starter/tasks/gems.rb

@@ -1,6 +1,6 @@
 require "starter/tasks/starter"
 
-gemspec_path = FileList["*.gemspec"].first || "#{$STARTER[:directory]}.gemspec"
+gemspec_path = FileList["*.gemspec"].first || "#{Starter.cache[:directory]}.gemspec"
 project_name = gemspec_path.chomp(".gemspec")
 
 task "bootstrap" => [ gemspec_path, "lib", "lib/#{project_name}.rb" ]
@@ -23,8 +23,8 @@ end
 file gemspec_path do |target|
   File.open(target.name, "w") do |file|
     file.puts gemspec_template(
-      :author => $STARTER[:author],
-      :project_name => $STARTER[:directory]
+      :author => Starter.cache[:author],
+      :project_name => Starter.cache[:directory]
     )
   end
 end
@@ -47,8 +47,9 @@ task "gem:push" do
   end
 end
 
+desc "Install dependencies from the gemspec"
 task "gem:deps" => "read_gemspec" do
-  gemspec = $STARTER[:gemspec]
+  gemspec = Starter.cache[:gemspec]
 
   require 'rubygems/dependency_installer'
   installer = Gem::DependencyInstaller.new
@@ -63,11 +64,11 @@ task "gem:deps" => "read_gemspec" do
 end
 
 task "version" => "read_gemspec" do
-  $STARTER[:version] = $STARTER[:gemspec].version.version
+  Starter.cache[:version] = Starter.cache[:gemspec].version.version
 end
 
 task "read_gemspec" do
-  $STARTER[:gemspec] = read_gemspec(gemspec_path)
+  Starter.cache[:gemspec] = read_gemspec(gemspec_path)
 end
 
 task "clean" do

data/lib/starter/tasks/git.rb

@@ -6,7 +6,7 @@ desc "Create a git tag using the project version"
 # Note that the user of this library must ensure that a task named
 # "version" is defined before invocation time.
 task "git:tag" => "version" do
-  version = $STARTER[:version]
+  version = Starter.cache[:version]
   git_tag = `git tag -l #{version}`.chomp
   if git_tag == version
     puts "Tag #{version} already exists. Bump your version."

data/lib/starter/tasks/github.rb

@@ -3,7 +3,7 @@ require "starter/tasks/starter"
 desc "Create an issue on GitHub"
 task "github:issues:create" => "github_repo" do
 
-  repo = $STARTER[:github_repo]
+  repo = Starter.cache[:github_repo]
   labels = repo.labels.map { |label| label["name"] }.join(" ")
   milestones = repo.milestones
 
@@ -64,7 +64,7 @@ end
 
 desc "show GitHub issues. Optional labels= and format="
 task "github:issues" => "github_repo" do
-  repo = $STARTER[:github_repo]
+  repo = Starter.cache[:github_repo]
   options = {}
   require "pp"
   if labels = ENV["labels"] || ENV["label"]
@@ -85,7 +85,7 @@ end
 
 desc "show issues for current milestone on GitHub"
 task "github:milestones:current" => "github_repo" do
-  repo = $STARTER[:github_repo]
+  repo = Starter.cache[:github_repo]
   milestones = repo.milestones
   sorted = milestones.sort_by {|m| m["due_on"] || "0" }
   current = sorted.last
@@ -106,7 +106,7 @@ end
 task "github_repo" => %w[ github_settings github_auth ] do
   require 'ghee'
 
-  settings = $STARTER[:settings][:github]
+  settings = Starter.cache[:settings][:github]
   repo = settings[:repo]
   ghee = Ghee.access_token(settings[:auth])
 
@@ -115,7 +115,7 @@ task "github_repo" => %w[ github_settings github_auth ] do
     puts repo["message"]
     exit
   else
-    $STARTER[:github_repo] = repo
+    Starter.cache[:github_repo] = repo
   end
 
 end
@@ -123,12 +123,12 @@ end
 task "github_auth" => %w[ github_settings .starter ] do
   require "starter/password"
   require 'ghee'
-  settings = $STARTER[:settings][:github]
+  settings = Starter.cache[:settings][:github]
   if File.exists?(".starter/gh_auth") && auth = File.read(".starter/gh_auth")
     settings[:auth] = auth.chomp
   else
     password = Starter::Password.request("GitHub")
-    user = $STARTER[:settings][:github][:user]
+    user = Starter.cache[:settings][:github][:user]
     auth = Ghee.create_token(user, password, ["user", "repo"])
     if auth
       settings[:auth] = auth
@@ -146,7 +146,7 @@ end
 task "read_settings" => ".starter" do
   require "yaml"
   begin
-    $STARTER[:settings] = YAML.load_file(".starter/settings.yml")
+    Starter.cache[:settings] = YAML.load_file(".starter/settings.yml")
   rescue Errno::ENOENT
     $stderr.puts "You do not appear to have a .starter/settings.yml file."
     if Starter::Prompt.confirm("Create a stubbed settings file?")
@@ -154,7 +154,7 @@ task "read_settings" => ".starter" do
         settings = {
           :github => {
             :user => "YOURUSERNAME",
-            :repo => {:owner => "OWNERNAME", :name => $STARTER[:directory]}
+            :repo => {:owner => "OWNERNAME", :name => Starter.cache[:directory]}
           }
         }
         YAML.dump(settings, f)
@@ -167,7 +167,7 @@ end
 
 
 task "github_settings" => "read_settings" do
-  if $STARTER[:settings][:github] == nil
+  if Starter.cache[:settings][:github] == nil
     $stderr.puts "Looks like your .starter/settings.yml file isn't set up with a github stanza."
     exit
   end

data/lib/starter/tasks/markdown.rb

@@ -4,7 +4,7 @@ task "bootstrap" => %w[ README.md ]
 file "README.md" do |target|
    File.open(target.name, "w") do |file|
     file.puts readme(
-      :project_name => $STARTER[:directory]
+      :project_name => Starter.cache[:directory]
     )
   end 
 end

data/lib/starter/tasks/npm.rb

@@ -11,12 +11,12 @@ desc "publish as an NPM package"
 task "release" => %w[ npm:publish ]
 
 task "npm:publish" => %w[ version ] do
-  puts "Version in package.json is #{$STARTER[:version]}"
+  puts "Version in package.json is #{Starter.cache[:version]}"
   confirm_command("npm publish")
 end
 
 task "version" => "read_package" do
-  $STARTER[:version] = $STARTER[:npm_package][:version]
+  Starter.cache[:version] = Starter.cache[:npm_package][:version]
 end
 
 # this seems like it ought to be a function? leaving it here because it seems
@@ -24,7 +24,7 @@ end
 task "read_package" do
   require "json"
   string = File.read("package.json")
-  $STARTER[:npm_package] = JSON.parse(string, :symbolize_names => true)
+  Starter.cache[:npm_package] = JSON.parse(string, :symbolize_names => true)
 end
 
 

data/lib/starter/tasks/starter.rb

@@ -1,11 +1,17 @@
 require "pp"
+
+module Starter
+  def self.cache
+    @cache ||= {}
+  end
+end
+
 require "starter/prompt"
 require "starter/extensions/string"
 require "git"
 
-$STARTER ||= {}
 
-$STARTER[:directory] = File.basename(Dir.pwd)
+Starter.cache[:directory] = File.basename(Dir.pwd)
 
 # Interface task declarations
 
@@ -22,17 +28,17 @@ task ".starter" do
 end
 
 task "determine_author" => %w[ read_git_config ] do
-  if (git = $STARTER[:git]) && (author = git.config["user.name"])
-    $STARTER[:author] = author
+  if (git = Starter.cache[:git]) && (author = git.config["user.name"])
+    Starter.cache[:author] = author
   else
-    $STARTER[:author] = Starter::Prompt.prompt("Project author?")
+    Starter.cache[:author] = Starter::Prompt.prompt("Project author?")
   end
 end
 
 task "read_git_config" do
   if File.exist?(".git")
     g = Git.open(Dir.pwd)
-    $STARTER[:git] = g
+    Starter.cache[:git] = g
   end
 end
 

metadata

@@ -1,64 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: starter
 version: !ruby/object:Gem::Version
-  version: 0.1.10
-  prerelease: 
+  version: 0.1.11
 platform: ruby
 authors:
 - Matthew King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-30 00:00:00.000000000 Z
+date: 2014-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.6
 - !ruby/object:Gem::Dependency
   name: ghee
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 description: 
 email: 
 executables: []
@@ -66,12 +59,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- Rakefile
 - README.md
+- Rakefile
 - lib/starter/extensions/module.rb
 - lib/starter/extensions/string.rb
 - lib/starter/http.rb
 - lib/starter/markdown.rb
+- lib/starter/markdown/extender.rb
 - lib/starter/misc.rb
 - lib/starter/mixins/statistics.rb
 - lib/starter/password.rb
@@ -86,26 +80,25 @@ files:
 - lib/starter/tasks/starter.rb
 homepage: https://github.com/automatthew/starter
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Generally useful and reusable things
 test_files: []