double_doc 1.2.1 → 1.3.0

data/lib/double_doc/doc_extractor.rb

@@ -1,7 +1,8 @@
 module DoubleDoc
   class DocExtractor
     TYPES = {
-      'rb' => /\s*##\s?(.*)$/
+      'rb' => /\s*##\s?(.*)$/,
+      'js' => %r{\s*///\s?(.*)$}
       }.freeze
 
     def self.extract(source, options = {})

data/lib/double_doc/import_handler.rb

@@ -3,8 +3,22 @@ require 'double_doc/doc_extractor'
 
 module DoubleDoc
   class ImportHandler
-    def initialize(root)
+    attr_reader :root, :load_paths
+
+    def initialize(root, options = {})
       @root = Pathname.new(root)
+      @load_paths = [@root]
+
+      if options[:gemfile]
+        gemfile = @root + "Gemfile"
+
+        unless gemfile.exist?
+          raise LoadError, "missing Gemfile inside #{@root}"
+        end
+
+        @load_paths.concat(load_paths_from_gemfile(gemfile))
+      end
+
       @docs = {}
     end
 
@@ -23,6 +37,20 @@ module DoubleDoc
 
     protected
 
+    def load_paths_from_gemfile(gemfile)
+      with_gemfile(gemfile) do
+        puts "Loading paths from #{gemfile}"
+
+        defn = Bundler::Definition.build(gemfile, @root + "Gemfile.lock", nil)
+        defn.validate_ruby!
+        defn.resolve_with_cache!
+
+        defn.specs.inject([]) do |paths, spec|
+          paths.concat(spec.load_paths.map {|p| Pathname.new(p)})
+        end
+      end
+    end
+
     def resolve_imports_from_lines(lines)
       doc = []
 
@@ -40,7 +68,7 @@ module DoubleDoc
     def get_doc(path)
       return @docs[path] if @docs[path]
 
-      file = File.new(@root + path)
+      file = find_file(path)
 
       if path =~ /\.md$/
         @docs[path] = resolve_imports(file)
@@ -48,5 +76,24 @@ module DoubleDoc
         @docs[path] = resolve_imports(DocExtractor.extract(file))
       end
     end
+
+    def find_file(path)
+      load_path = @load_paths.detect do |load_path|
+        (load_path + path).exist?
+      end
+
+      unless load_path
+        raise LoadError, "No such file or directory: #{path}"
+      end
+
+      File.new(load_path + path)
+    end
+
+    def with_gemfile(gemfile)
+      ENV["BUNDLE_GEMFILE"], orig_gemfile = gemfile.to_s, ENV["BUNDLE_GEMFILE"]
+      yield
+    ensure
+      ENV["BUNDLE_GEMFILE"] = orig_gemfile
+    end
   end
 end

data/lib/double_doc/task.rb

@@ -57,7 +57,7 @@ module DoubleDoc
 
       desc "Generate markdown #{html_dst ? 'and HTML ' : ''}DoubleDoc documentation from #{sources.join(', ')}"
       generated_task = task(task_name => destinations) do |t, args|
-        import_handler = DoubleDoc::ImportHandler.new(options[:root] || Rake.original_dir)
+        import_handler = DoubleDoc::ImportHandler.new(options[:root] || Rake.original_dir, options.fetch(:import, {}))
 
         generated_md_files = []
 

data/lib/double_doc/version.rb

@@ -1,4 +1,4 @@
-## ## DoubleDoc 1.2
+## ## DoubleDoc 1.3
 module DoubleDoc
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/{README.md → readme.md}

@@ -1,4 +1,4 @@
-## DoubleDoc 1.2
+## DoubleDoc 1.3
 
 One of the challenges you face when writing public documention for code or APIs, is that you have to remember to update the documentation
 when ever you change the API. The main reason why this is a problem is that very often the documentation lives very for from your code.

data/test/doc_extractor_test.rb

@@ -1,31 +1,49 @@
 require 'test_helper'
 
 describe "the doc extractor" do
-  describe "on ruby files" do
-    ## this line should be extracted
-    # this line should not be extracted
-    ## this line should also be extracted
 
-    before do
-      @doc = DoubleDoc::DocExtractor.extract(File.new(__FILE__))
+  def self.it_acts_like_an_extractor
+    it "extracts documentation" do
+      subject.must_match(/this line should be extracted/)
+      subject.must_match(/this line should also be extracted/)
     end
 
-    it "should extract documentation from ruby files" do
-      @doc.must_match(/this line should be extracted/)
-      @doc.must_match(/this line should also be extracted/)
+    it "doesn't extract regular comments" do
+      subject.wont_match(/this line should not be extracted/)
     end
 
-    it "should not extract regular comments" do
-      @doc.wont_match(/this line should not be extracted/)
+    it "doesn't add any extra new-lines" do
+      subject.must_match(/^this/m)
+      subject.must_match(/extracted\n$/m)
     end
 
-    it "should not add any extra new-lines" do
-      @doc.must_match(/^this/m)
-      @doc.must_match(/extracted\n$/m)
+    it "adds an empty line between documentation sections" do
+      subject.must_match(/extracted\n\nthis/m)
     end
+  end
 
-    it "add an empty line between documentation sections" do
-      @doc.must_match(/extracted\n\nthis/m)
+  describe "on .rb files" do
+    ## this line should be extracted
+    # this line should not be extracted
+    ## this line should also be extracted
+
+    subject do
+      DoubleDoc::DocExtractor.extract(File.new(__FILE__))
+    end
+
+    it_acts_like_an_extractor
+  end
+
+  describe 'on .js files' do
+    subject do
+      source = <<-EOS
+        /// this line should be extracted
+        // this line should not be extracted
+        /// this line should also be extracted
+      EOS
+      DoubleDoc::DocExtractor.extract(source, :type => 'js')
     end
+
+    it_acts_like_an_extractor
   end
 end

data/test/fixtures/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "double_doc", :path => File.join(File.expand_path(File.dirname(__FILE__)), "..", "..")
+gem "mime-types", :git => "https://github.com/halostatue/mime-types.git", :ref => "v1.22"

data/test/fixtures/Gemfile.lock

@@ -0,0 +1,34 @@
+GIT
+  remote: https://github.com/halostatue/mime-types.git
+  revision: b8d2208cc34e9b9ca6456182742dcb3bfc47daf6
+  ref: v1.22
+  specs:
+    mime-types (1.20.1)
+
+PATH
+  remote: /Users/staugaard/code/double_doc
+  specs:
+    double_doc (1.3.0)
+      erubis
+      pygments.rb (~> 0.2)
+      rake
+      redcarpet (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    erubis (2.7.0)
+    posix-spawn (0.3.6)
+    pygments.rb (0.5.0)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.1.0)
+    rake (10.0.4)
+    redcarpet (2.2.2)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  double_doc!
+  mime-types!

data/test/import_handler_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+describe "import handler" do
+  subject do
+    DoubleDoc::ImportHandler.new(root, options)
+  end
+
+  after do
+    ENV["BUNDLE_GEMFILE"] = Bundler.root.join("Gemfile").to_s
+  end
+
+  describe "with gemfile" do
+    let(:root) { Bundler.root }
+    let(:options) {{ :gemfile => true }}
+
+    describe "when root has no tmpfile" do
+      let(:root) { Bundler.root + "lib" }
+
+      describe "initialization" do
+        it "should raise" do
+          lambda { subject }.must_raise LoadError
+        end
+      end
+    end
+
+    describe "rubygems" do
+      describe "load_paths" do
+        it "should add Gemfile load paths" do
+          subject.load_paths.must_include subject.root
+          subject.load_paths.size.must_be :>, 1
+        end
+      end
+
+      describe "find_file" do
+        it "should resolve files" do
+          subject.send(:find_file, "bundler.rb").must_be_instance_of File
+        end
+
+        it "should raise if unable to find file" do
+          lambda do
+            subject.send(:find_file, "nope.rb")
+          end.must_raise LoadError
+        end
+      end
+    end
+
+    describe "path, git" do
+      let(:root) { File.join(File.expand_path(File.dirname(__FILE__)), "fixtures") }
+
+      describe "find_file" do
+        it "should resolve files from path" do
+          subject.send(:find_file, "double_doc.rb").must_be_instance_of File
+        end
+
+        it "should resolve file from git" do
+          subject.send(:find_file, "mime-types.rb").must_be_instance_of File
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,118 +1,120 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: double_doc
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 1.3.0
   prerelease: 
-  segments: 
-  - 1
-  - 2
-  - 1
-  version: 1.2.1
 platform: ruby
-authors: 
+authors:
 - Mick Staugaard
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-16 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: guard
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: minitest
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: erubis
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: redcarpet
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 2
-        - 1
-        version: "2.1"
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :runtime
   prerelease: false
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
   name: pygments.rb
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 0
-        - 2
-        version: "0.2"
+      - !ruby/object:Gem::Version
+        version: '0.2'
   type: :runtime
   prerelease: false
-  requirement: *id006
-description: A simple framework for writing and generating beautiful documentation for your code
-email: 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: A simple framework for writing and generating beautiful documentation
+  for your code
+email:
 - mick@staugaard.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/double_doc/doc_extractor.rb
 - lib/double_doc/html_generator.rb
 - lib/double_doc/html_renderer.rb
@@ -124,44 +126,59 @@ files:
 - lib/guard/doubledoc.rb
 - templates/default.html.erb
 - templates/screen.css
-- README.md
+- readme.md
 - test/doc_extractor_test.rb
+- test/fixtures/Gemfile
+- test/fixtures/Gemfile.lock
+- test/fixtures/vendor/cache/erubis-2.7.0.gem
+- test/fixtures/vendor/cache/posix-spawn-0.3.6.gem
+- test/fixtures/vendor/cache/pygments.rb-0.5.0.gem
+- test/fixtures/vendor/cache/rake-10.0.4.gem
+- test/fixtures/vendor/cache/redcarpet-2.2.2.gem
+- test/fixtures/vendor/cache/yajl-ruby-1.1.0.gem
 - test/html_generator_test.rb
+- test/import_handler_test.rb
 - test/test_helper.rb
 homepage: http://staugaard.github.com/double_doc
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -1537526380922081734
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -1537526380922081734
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Documentation right where you want it
-test_files: 
+test_files:
 - test/doc_extractor_test.rb
+- test/fixtures/Gemfile
+- test/fixtures/Gemfile.lock
+- test/fixtures/vendor/cache/erubis-2.7.0.gem
+- test/fixtures/vendor/cache/posix-spawn-0.3.6.gem
+- test/fixtures/vendor/cache/pygments.rb-0.5.0.gem
+- test/fixtures/vendor/cache/rake-10.0.4.gem
+- test/fixtures/vendor/cache/redcarpet-2.2.2.gem
+- test/fixtures/vendor/cache/yajl-ruby-1.1.0.gem
 - test/html_generator_test.rb
+- test/import_handler_test.rb
 - test/test_helper.rb