oreilly-snippets 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c1f282b603c87774de48d0528a5a5c502b7f781
+  data.tar.gz: 1107766b02889b4bd04852cc6010594ffd347d1c
+SHA512:
+  metadata.gz: 0cfb0a42084e9391dfcbf575c327a48e3cab0fbf18214b4d7227f3c4d008dae3c65a3692d335faff429ac8ff81016b94c5e37efda3c7a0efdbf16eb521858f85
+  data.tar.gz: f8ea02d98b973a31bc8dcbedf52a471b40e0673646e16c12a7be2b3fbefbe489f240a03bbbe99e4039a3a8ba3f638973c2d58f70aa569b61e45fe0cc36bf294c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in oreilly-snippets.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Dawson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,175 @@
+# Oreilly::Snippets
+
+Write O'Reilly-style code snippets inside your Asciidoc or markdown files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'oreilly-snippets'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oreilly-snippets
+
+## Usage
+
+### Snippets Usage
+
+Check out (Code Snippets)[http://chimera.labs.oreilly.com/books/1230000000065/ch04.html#code_explanation]
+from O'Reilly.
+
+A snippet looks like this inside your markup.
+
+```
+[filename="coffeetech.js", language="js" identifier="IDENTIFIER"]
+snippet~~~~
+Put any descriptive text you want here. It will be replaced with the
+specified code snippet when you build ebook outputs
+snippet~~~~
+```
+
+Then, inside your `coffeetech.js` file you have something like this:
+
+```
+// BEGIN IDENTIFIER
+var mod = angular.module( 'coffeetech', [] );
+
+mod.factory( 'Github', function() {
+    return new Github({});
+});
+// END IDENTIFIER
+
+mod.factory( 'Geo', [ '$window', function( $window ) {
+    return $window.navigator.geolocation;
+} ] );
+
+```
+
+Putting that snippet into your markdown makes the markdown eventually
+end up like this:
+
+```
+var mod = angular.module( 'coffeetech', [] );
+
+mod.factory( 'Github', function() {
+    return new Github({});
+});
+```
+
+### Special additions to snippets
+
+You can also use syntax like this to pull from a specific commit in
+your git repository:
+
+```
+[filename="../../github.js.test", language="js", sha="8e05a916fe0b1a9d3e:coffeetech.js"]
+```
+
+This will look in the git repository in the `../../github.js.test`
+directory, then grab the file at the specific SHA hash. This means you
+can write code inside a repository, and add a snippet pointing to that
+exact revision in the repository.
+
+NB: This format of snippets is not currently compatible with Atlas
+from O'Reilly. However, you can always process the snippet and write
+out a normal Asciidoc file, a file which will be compatible with
+Atlas. See below for an example using Guard.
+
+### Using with Guard and live-reload
+
+One nice workflow is to edit files in your editor, then have guard
+running to process those files, and open them in the browser so that
+when you make changes the live-reload plugin will automatically reload
+the processed HTML. 
+
+The file structure I use for this:
+
+* Store my pre-processed files in the /pre directory. These are the
+  files which have the snippets. I need to have a special directory
+  because this means Atlas will ignore them, and guard will process
+  the files into the Asciidoc files used by Atlas.
+* In the directory root I have a bunch of .asciidoc files which are
+  the post-processed files, the files which have the snippets resolved
+  into real code.
+* Guard watches both directories. When I make a change to the files in
+  /pre, Guard regenerates the asciidoc files at the top level. When
+  Guard sees one of those files has been changed, it processes them
+  through Asciidoctor and then builds the HTML. 
+* I serve the HTML file using a combination of pow (pow.cx) and
+  config.ru. 
+* Use the live-reload plugin for Chrome:
+  https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei
+
+```
+require 'asciidoctor'
+require 'oreilly/snippets'
+
+# Add a bit of JS to each file before writing to HTML
+init_script = '<script type="text/javascript" src="init.js"></script>';
+
+guard 'shell' do
+  watch( /^pre\/[^\/]*\.asciidoc$/) {|m|
+    contents = File.read( m[0] )
+    snippetized = Oreilly::Snippets.process( contents )
+    snippet_out =  m[0].gsub( "pre/", "" )
+    File.open( snippet_out, "w+" ) do |f|
+      f.write snippetized
+      puts "Wrote new snippet: #{snippet_out}"
+    end
+  }
+end
+
+guard 'shell' do 
+  watch( /^[^\/]*\.asciidoc$/ ) { |m|
+    puts "File: #{m.inspect}"
+    asciidoc = File.read( m[0] )
+    out = Asciidoctor.render( asciidoc,
+                              :header_footer => true,
+                              :safe => Asciidoctor::SafeMode::SAFE,
+                              :attributes => {'linkcss!' => ''})
+
+    File.open( m[0]+ ".html", "w+" ) do |f|
+      out.gsub!( '</body>', "</body>\n#{init_script}\n" )
+      f.write out
+      puts "Wrote: #{m[0]+'.html'}"
+    end
+  }
+end
+
+guard 'livereload' do
+  watch(%r{^.+\.(css|js|html)$})
+end
+```
+
+My `config.ru`
+
+```
+app = proc do |env|
+  Rack::Directory.new('.').call(env)
+end
+
+run app
+```
+
+
+## Running the tests
+
+Install the `rspec` gem.
+
+```
+$ rspec 
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Write tests (see the tests in the spec/ directory)
+2. Commit your changes (`git commit -am 'Add some feature'`)
+3. Push to the branch (`git push origin my-new-feature`)
+4. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/oreilly/snippets/version.rb

@@ -0,0 +1,5 @@
+module Oreilly
+  module Snippets
+    VERSION = "0.0.1"
+  end
+end

data/lib/oreilly/snippets.rb

@@ -0,0 +1,87 @@
+require "oreilly/snippets/version"
+
+COMMENTS = {
+  :js => "\/\/",
+  :ruby => "#"
+}
+
+module Oreilly
+  module Snippets
+
+    def self.get_content_from_file( spec, identifier, language, sha=nil )
+      contents = nil
+      if sha
+        # Use the filename to change into the directory and use git-show
+        cwd = Dir.pwd
+        Dir.chdir spec
+        contents = `git show #{sha}`
+        Dir.chdir cwd
+      else
+        contents = File.read( spec )
+      end
+
+      rv = nil
+      if identifier
+        comments = COMMENTS[language.to_sym]
+        re = /#{comments} BEGIN #{identifier}\n(.*)\n#{comments} END #{identifier}\n/m
+        m = contents.match( re )
+        rv = m[1]
+      else
+        rv = contents
+      end
+
+      # rv = scrub_other_identifiers( contents, comments )
+      rv
+    end
+
+    def self.scrub_other_identifiers( s, comments )
+      puts s
+      re = /#{comments} BEGIN \S+\n(.*)\n#{comments} END \S+\n/m
+      s.gsub!( re, $1 )
+      s
+    end
+    
+    def self.process( input )
+      snippets = parse( input )
+      rv = input
+      if snippets and snippets.length > 0 
+        snippets.each do |s|
+          content = get_content_from_file( s[:filename], s[:identifier], s[:language], s[:sha] )
+          rv = rv.gsub( s[:full], content )
+        end
+      end
+      rv
+    end
+    
+    def self.parse( input )
+      output = []
+      input.scan( /(\[[^\]]*\])(\s+)(snippet[^\s]*)(.*?)\3/m ) do |m|
+        # Add it all up, and include the snippet piece (second to last captured)
+        full = m.join( "" ) + m[m.length-2]
+        match = {}
+        m[0].scan( /([^=\[,\s]*)="([^"]*)"/ ) do |kv|
+          match[kv[0].to_sym] = kv[1]
+        end
+        match[:full] = full.strip
+        output << match
+      end
+      output
+    end
+  end
+end
+# To include this snippet in an AsciiDoc file, add the following block:
+
+#   [filename="factorial.js", language="js", identifier="FACTORIAL_FUNC"]
+# snippet~~~~
+#   Put any descriptive text you want here. It will be replaced with the
+# specified code snippet when you build ebook outputs
+# snippet~~~~
+#   When the ebook is generated, the following output will be present in place of the snippet block:
+
+#   function factorial(number) {
+#                if (number == 0) {
+#                    return 1
+#                  } else {
+#                    return factorial(number - 1) * number
+#                  }
+#   }

data/oreilly-snippets.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oreilly/snippets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oreilly-snippets"
+  spec.version       = Oreilly::Snippets::VERSION
+  spec.authors       = ["Chris Dawson"]
+  spec.email         = ["xrdawson@gmail.com"]
+  spec.description   = %q{Use O'Reilly style snippets inside your markup (asciidoc or markdown) files}
+  spec.summary       = %q{See the README}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/fixtures/coffeetech.js

@@ -0,0 +1,25 @@
+// BEGIN MODULE_DEFINITION
+var mod = angular.module( 'coffeetech', [] );
+
+mod.factory( 'Github', function() {
+    return new Github({});
+});
+// END MODULE_DEFINITION
+
+mod.factory( 'Geo', [ '$window', function( $window ) {
+    return $window.navigator.geolocation;
+} ] );
+
+mod.controller( 'GithubCtrl', [ '$scope', 'Github', 'Geo', function( $scope, ghs, Geo ) {
+    $scope.messages = []
+
+    $scope.init = function() {
+        $scope.getCurrentLocation( function( position ) {
+            $scope.latitude = position.coords.latitude;
+            $scope.longitude = position.coords.longitude;
+
+// BEGIN FOOBAR
+
+alert( "Something" );
+
+// END FOOBAR

data/spec/fixtures/factorial.js

@@ -0,0 +1,12 @@
+alert("This code has a snippet below!");
+factorial(3);
+
+// BEGIN FACTORIAL_FUNC
+function factorial(number) {
+    if (number == 0) {
+       return 1
+       } else {
+        return factorial(number - 1) * number
+  }
+}
+// END FACTORIAL_FUNC

data/spec/process_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+WITH_SHA = <<END
+[filename="../../github.js.test", language="js", sha="8e05a916fe0b1a9d3e:coffeetech.js"]
+snippet~~~~
+Put any descriptive text you want here. It will be replaced with the
+snippet~~~~
+END
+
+ORIGINAL_CONTENTS = <<END
+var mod = angular.module( 'coffeetech', [] )
+mod.controller( 'ShopsCtrl', function( $scope ) {
+  var github = new Github({} );
+  var repo = github.getRepo( "xrd", "spa.coffeete.ch" ); 
+  repo.contents( "gh-pages", "portland.json", function(err, data) { 
+    $scope.shops = JSON.parse( data );
+    $scope.$digest();
+  }, false );
+})
+END
+
+LOTS_OF_IDENTIFIERS = <<END
+
+[filename="spec/fixtures/coffeetech.js", language="js"]
+snippet~~~~
+Put any descriptive text you want here. It will be replaced with the
+specified code snippet when you build ebook outputs
+snippet~~~~
+
+END
+
+
+FULL = <<END
+[filename="spec/fixtures/factorial.js", language="js", identifier="FACTORIAL_FUNC"]
+snippet~~~~
+Put any descriptive text you want here. It will be replaced with the
+specified code snippet when you build ebook outputs
+snippet~~~~
+END
+
+TEMPLATE = <<END
+
+ABC
+
+#{FULL}
+
+DEF
+
+END
+
+WRAPPED_BY_SOURCE = <<END
+
+[source,javascript]
+-----
+[filename="spec/fixtures/coffeetech.js", language="js", identifier="MODULE_DEFINITION"]
+snippet~~~~~
+var mod = angular.module( 'coffeetech', [] )
+mod.controller( 'GithubCtrl', function( $scope ) {
+  var github = new Github({} );
+  var repo = github.getRepo( "gollum", "gollum" );
+  repo.show( function(err, repo) {
+    $scope.repo = repo;
+    $scope.$apply();
+  });
+})
+snippet~~~~~
+-----
+
+END
+
+describe "#parse" do
+
+  it "should parse wrapped items" do
+    outputs = Oreilly::Snippets.parse( WRAPPED_BY_SOURCE )
+    output = outputs[0]
+    output[:filename].should == "spec/fixtures/coffeetech.js"
+    output[:language].should == "js"
+    output[:identifier].should == "MODULE_DEFINITION"
+  end
+  
+  it "should parse the file and extract the correct things" do
+    outputs = Oreilly::Snippets.parse( TEMPLATE )
+    output = outputs[0]
+    output[:filename].should == "spec/fixtures/factorial.js"
+    output[:language].should == "js"
+    output[:identifier].should == "FACTORIAL_FUNC"
+    output[:full].strip.should == FULL.strip
+  end
+
+  it "should get the SHA when specified" do
+    outputs = Oreilly::Snippets.parse( WITH_SHA )
+    output = outputs[0]
+    output[:sha].should == "8e05a916fe0b1a9d3e:coffeetech.js"
+  end
+end
+
+# describe "#scrub_other_identifiers" do
+#   it "should scrub everything that looks like an identifier" do
+#     out = Oreilly::Snippets.scrub_other_identifiers( File.read( "spec/fixtures/coffeetech.js" ), "//" )
+#     out.should_not match( /FOOBAR/ )
+#   end
+# end
+
+describe "#process" do
+
+  it "should process a complex file" do
+    output = Oreilly::Snippets.process( WRAPPED_BY_SOURCE )
+    output.should_not match( /MODULE_DEFINITION/ )
+    output.should_not match( /\/\/$/ )
+  end
+  
+  it "should process a simple file" do
+    output = Oreilly::Snippets.process( TEMPLATE )
+    output.should match( /ABC/ )
+    output.should match( /DEF/ )
+    output.should match( /function factorial\(number\)/ )
+    output.should_not match( /BEGIN FACTORIAL_FUNC/ )
+    output.should_not match( /END FACTORIAL_FUNC/ ) 
+  end
+
+  # NYI
+  # it "should remove all identifiers when processing" do
+  #   output = Oreilly::Snippets.process( LOTS_OF_IDENTIFIERS )
+  #   output.should_not match( /BEGIN/ )
+  # end
+  
+  describe "#git" do
+    it "should retrieve by SHA if specified" do
+      output = Oreilly::Snippets.process( WITH_SHA )
+      ORIGINAL_CONTENTS.strip.should == output.strip
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'oreilly/snippets'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: oreilly-snippets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Dawson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-04 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  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'
+description: Use O'Reilly style snippets inside your markup (asciidoc or markdown)
+  files
+email:
+- xrdawson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/oreilly/snippets.rb
+- lib/oreilly/snippets/version.rb
+- oreilly-snippets.gemspec
+- spec/fixtures/coffeetech.js
+- spec/fixtures/factorial.js
+- spec/process_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.2
+signing_key: 
+specification_version: 4
+summary: See the README
+test_files:
+- spec/fixtures/coffeetech.js
+- spec/fixtures/factorial.js
+- spec/process_spec.rb
+- spec/spec_helper.rb