doc_repo 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30dd0cd755d3202ed2e493d13e43283ad50be7ae
-  data.tar.gz: d87c1f901a3e3a63f165b8211b0e7049a48ea9be
+  metadata.gz: fc7d8c08c2b6224d86b67f6d1a3fbaa7eeba0c9d
+  data.tar.gz: b6d49db3309f95fe6dc30d97b2ae45dc02522242
 SHA512:
-  metadata.gz: 18271a91e38f64eedfe8823d23fc0106953dc7e7c8f2ecb48c8f41dd54161fe46aaf164e09101c5486ad9fb8ae2a8f5a7bb2fa4ff85127d562a15eb8e0d46c97
-  data.tar.gz: 9e34106363f55e04f7a8e9371b08bc2b18f7862a07b77db118986707592eacd9f0dbf5b8e4328ba11ab06cdcd5af4415c165f4e008ed2a23ed6860fbafb8a25d
+  metadata.gz: 19488fa0c31b900f1f679c309c9921627fa0a9963a312c2657323c5938ae425328701ebcdda02382c234f69c859a88c44c1c4bf852617247bf4d07141739a35f
+  data.tar.gz: aec5d27ab0a945616e4d08fd02ffcaca3c75e94da608dd20b0710d6589166125a769208e68301c9672eb39044744a3be27b62df055162371b4dd441e667c6484

data/.gitignore

@@ -7,8 +7,14 @@
 /pkg/
 /spec/reports/
 /tmp/
-*.bundle
 *.so
 *.o
 *.a
 mkmf.log
+
+# Ignore development related binstubs
+/bin/
+
+# Ignore bundler related files
+/bundle/
+*.bundle

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+sudo: false
+bundler_args: --binstubs --standalone --without documentation debug
+script: bin/rspec
+rvm:
+  - 2.0
+  - 2.1
+  - ruby-head
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-2
+  fast_finish: true

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in doc_repo.gemspec
 gemspec
+
+group :debug do
+  gem "pry-nav"
+  gem "travis-lint", require: false
+end

data/README.md

@@ -43,7 +43,8 @@ Create a controller to render the documentation pages. In Rails you might use so
 ```ruby
 class DocsController < ApplicationController
   def index
-    # If you don't want to store the index view in the app, just redirect to one of the documentation pages:
+    # If you don't want to store the index view in the app, just redirect to
+    # one of the documentation pages:
     redirect_to doc_path('index')
   end
 

data/doc_repo.gemspec

@@ -9,21 +9,22 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Christopher Sexton"]
   spec.email         = ["github@codeography.com"]
   spec.summary       = "Doc Repo: Load in app documentation via an external Github repo"
-  spec.description   = ""
-  spec.homepage      = ""
+  spec.description   = "Doc Repo: Load in app documentation via an external Github repo"
+  spec.homepage      = "https://github.com/RadiusNetworks/doc_repo"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = %w[ ]
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rouge", "~> 1.6"
-  spec.add_dependency "redcarpet", "~> 3.1"
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency "rouge", "~> 1.8"
+  spec.add_dependency "redcarpet", "~> 3.2"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "webmock", "~> 1.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock", "~> 1.0"
 end

data/lib/doc_repo.rb

@@ -1,13 +1,12 @@
 require "doc_repo/version"
 
-require "doc_repo/configuration"
-require "doc_repo/github_file"
-require "doc_repo/page"
-require "doc_repo/repository"
-require "doc_repo/response"
-require "doc_repo/converters/markdown_parser"
-
 module DocRepo
+  autoload :Configuration, "doc_repo/configuration"
+  autoload :GithubFile, "doc_repo/github_file"
+  autoload :Page, "doc_repo/page"
+  autoload :Repository, "doc_repo/repository"
+  autoload :Response, "doc_repo/response"
+
   BadPageFormat = Class.new(StandardError)
   NotFound      = Class.new(StandardError)
 

data/lib/doc_repo/configuration.rb

@@ -3,8 +3,9 @@ module DocRepo
     attr_accessor :org, :repo, :branch
 
     def initialize
-      @org = "RadiusNetworks"
-      @branch = "master"
+      @org    = ENV['DOC_REPO_ORG']
+      @repo   = ENV['DOC_REPO_REPONAME']
+      @branch = ENV['DOC_REPO_BRANCH'] || "master"
     end
   end
 end

data/lib/doc_repo/converters/markdown_parser.rb

@@ -25,11 +25,12 @@ module DocRepo
           "<div class=\"highlight\">#{add_code_tags(code, lang)}</div>"
         end
 
-        protected
+      protected
 
-        def rouge_formatter(opts = {})
-          Rouge::Formatters::HTML.new(opts.merge(wrap: false))
+        def rouge_formatter(lexer)
+          Rouge::Formatters::HTML.new(wrap: false)
         end
+
       end
 
       def initialize(config)
@@ -51,8 +52,8 @@ module DocRepo
         markdown.render(content)
       end
 
-      private
       attr_reader :config, :extensions, :renderer
+      private :config, :extensions, :renderer
     end
   end
 end

data/lib/doc_repo/github_file.rb

@@ -20,7 +20,7 @@ module DocRepo
 
     def read_remote_file
       open(url(file), headers).read
-    rescue OpenURI::HTTPError => e
+    rescue OpenURI::HTTPError => _ignore
       raise DocRepo::NotFound
     end
 

data/lib/doc_repo/page.rb

@@ -1,3 +1,5 @@
+require "doc_repo/converters/markdown_parser"
+
 module DocRepo
   class Page
     attr_accessor :body

data/lib/doc_repo/response.rb

@@ -14,11 +14,11 @@ module DocRepo
     end
 
     def html
-      yield *params if type == :html
+      yield(*params) if type == :html
     end
 
     def redirect
-      yield *params if type == :redirect
+      yield(*params) if type == :redirect
     end
   end
 end

data/lib/doc_repo/version.rb

@@ -1,3 +1,3 @@
 module DocRepo
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/doc_repo/configuration_spec.rb

@@ -0,0 +1,55 @@
+require 'support/using_env'
+
+RSpec.describe DocRepo::Configuration do
+
+  context "without environment variables configured" do
+    subject(:default_config) { DocRepo::Configuration.new }
+
+    around do |example|
+      env = {
+        'DOC_REPO_ORG'      => nil,
+        'DOC_REPO_REPONAME' => nil,
+        'DOC_REPO_BRANCH'   => nil,
+      }
+      using_env(env, &example)
+    end
+
+    it "has no org" do
+      expect(default_config.org).to be nil
+    end
+
+    it "has no repo" do
+      expect(default_config.repo).to be nil
+    end
+
+    it "use the 'master' branch" do
+      expect(default_config.branch).to eq 'master'
+    end
+  end
+
+  context "with environment variables configured" do
+    subject(:default_env_config) { DocRepo::Configuration.new }
+
+    around do |example|
+      env = {
+        'DOC_REPO_ORG'      => 'the-silence',
+        'DOC_REPO_REPONAME' => 'falls',
+        'DOC_REPO_BRANCH'   => 'ask_the_question',
+      }
+      using_env(env, &example)
+    end
+
+    it "uses DOC_REPO_ORG for the default org" do
+      expect(default_env_config.org).to eq 'the-silence'
+    end
+
+    it "uses DOC_REPO_REPONAME for the default repo" do
+      expect(default_env_config.repo).to eq 'falls'
+    end
+
+    it "uses DOC_REPO_BRANCH for the default branch" do
+      expect(default_env_config.branch).to eq 'ask_the_question'
+    end
+  end
+
+end

data/spec/doc_repo/page_spec.rb

@@ -1,11 +1,12 @@
-require 'spec_helper'
+require 'support/string'
+require 'webmock/rspec'
 
 RSpec.describe DocRepo::Page do
-  def tempfile(body)
-    Tempfile.open("spec") do |f|
-      f.puts body
-      f.rewind
-      yield f
+  before do
+    DocRepo.configure do |c|
+      c.org = 'RadiusNetworks'
+      c.repo = 'doc_spec'
+      c.branch = 'master'
     end
   end
 
@@ -19,7 +20,6 @@ RSpec.describe DocRepo::Page do
     stub_request(:get, "https://api.github.com/repos/RadiusNetworks/doc_spec/contents/docs/page.md?ref=master")
       .to_return(body: body)
 
-
     page = DocRepo::Page.new("page")
     expect(page.to_html).to eq <<-END.strip_heredoc
         <h1 id=\"a-heading\">A heading</h1>

data/spec/doc_repo/response_spec.rb

@@ -3,17 +3,17 @@ require 'spec_helper'
 RSpec.describe DocRepo::Page do
   it "calls html block with 1 param" do
     resp = DocRepo::Response.html 1
-    expect { |b| resp.html &b }.to yield_with_args(1)
+    expect { |b| resp.html(&b) }.to yield_with_args(1)
   end
 
   it "calls html block with 2 params" do
     resp = DocRepo::Response.html 1, 2
-    expect { |b| resp.html &b }.to yield_with_args(1, 2)
+    expect { |b| resp.html(&b) }.to yield_with_args(1, 2)
   end
 
   it "calls file block with 1 param" do
     resp = DocRepo::Response.html "/path/to/file"
-    expect { |b| resp.html &b }.to yield_with_args("/path/to/file")
+    expect { |b| resp.html(&b) }.to yield_with_args("/path/to/file")
   end
 end
 

data/spec/spec_helper.rb

@@ -1,17 +1,7 @@
-require 'webmock/rspec'
-require 'pry'
-require 'doc_repo'
-
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+# This is a very warning riddled gem, load it before we enable warnings
+require 'rouge'
 
 RSpec.configure do |config|
-
-  config.before do
-    DocRepo.configure do |c|
-      c.org = 'RadiusNetworks'
-      c.repo = 'doc_spec'
-    end
-  end
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
@@ -27,3 +17,6 @@ RSpec.configure do |config|
   end
   Kernel.srand config.seed
 end
+
+# Load our lib after warnings are enabled so we can fix them
+require 'doc_repo'

data/spec/support/using_env.rb

@@ -0,0 +1,26 @@
+module DocRepo
+  module RSpec
+    module Helpers
+
+      # By forcing the use of a block, this makes working within the context of
+      # a single spec much easier. If this needs to be wrapped around multiple
+      # specs, then an appropriate #around(:example) hook may be used.
+      def using_env(env_stubs, &lifetime)
+        keys_to_delete = env_stubs.keys - ENV.keys
+        original_values = env_stubs.each_with_object({}) { |(k, v), env|
+          env[k] = ENV[k] if ENV.has_key?(k)
+          ENV[k] = v
+        }
+        lifetime.call
+      ensure
+        keys_to_delete.each{ |k| ENV.delete(k) }
+        original_values.each{ |k, v| ENV[k] = v }
+      end
+
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include DocRepo::RSpec::Helpers
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doc_repo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Christopher Sexton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-06 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rouge
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,20 +81,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: ''
+        version: '1.0'
+description: 'Doc Repo: Load in app documentation via an external Github repo'
 email:
 - github@codeography.com
 executables: []
@@ -117,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -130,13 +117,15 @@ files:
 - lib/doc_repo/repository.rb
 - lib/doc_repo/response.rb
 - lib/doc_repo/version.rb
+- spec/doc_repo/configuration_spec.rb
 - spec/doc_repo/page_spec.rb
 - spec/doc_repo/repository_spec.rb
 - spec/doc_repo/response_spec.rb
 - spec/doc_repo_spec.rb
 - spec/spec_helper.rb
 - spec/support/string.rb
-homepage: ''
+- spec/support/using_env.rb
+homepage: https://github.com/RadiusNetworks/doc_repo
 licenses:
 - MIT
 metadata: {}
@@ -146,9 +135,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -156,14 +145,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: 'Doc Repo: Load in app documentation via an external Github repo'
 test_files:
+- spec/doc_repo/configuration_spec.rb
 - spec/doc_repo/page_spec.rb
 - spec/doc_repo/repository_spec.rb
 - spec/doc_repo/response_spec.rb
 - spec/doc_repo_spec.rb
 - spec/spec_helper.rb
 - spec/support/string.rb
+- spec/support/using_env.rb