api_guides 0.1.0

data/spec/lib/document_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe ApiGuides::Document do
+  describe ".from_xml" do
+    let(:xml) do
+      %Q{
+        <document>
+          <title>Foo</title>
+          <position>1</position>
+          <section title="Bar">
+            <docs>Docs</docs>
+            <reference title="Baz">Reference content</reference>
+            <examples>
+              <example language="ruby">ruby examples</example>
+              <example language="python">python examples</example>
+            </examples>
+          </section>
+        </document>
+      }
+    end
+
+    let(:section) { double('Section') }
+
+    before(:each) do
+      ApiGuides::Section.should_receive(:from_xml).and_return(section) 
+    end
+
+    subject { ApiGuides::Document.from_xml(xml) }
+
+    its(:title) { should == 'Foo' }
+
+    its(:position) { should == 1 }
+
+    its(:sections) { should == [section] }
+  end
+
+  describe "#initialize" do
+    it "should set the position if given" do
+      document = ApiGuides::Document.new :position => 1
+      document.position.should == 1
+    end
+
+    it "should set the title if given" do
+      document = ApiGuides::Document.new :title => 'Foo'
+      document.title.should == 'Foo'
+    end
+
+    it "should set the sections if given" do
+      document = ApiGuides::Document.new :sections => []
+      document.sections.should == []
+    end
+  end
+end

data/spec/lib/example_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe ApiGuides::Example do
+  describe ".from_xml" do
+    let(:xml) { %Q{<example language="ruby">bar</example>} }
+
+    subject { ApiGuides::Example.from_xml(xml) }
+
+    its(:language) { should == 'ruby' }
+
+    its(:content) { should == 'bar' }
+  end
+
+  describe "#initialize" do
+    it "should set the language if given" do
+      example = ApiGuides::Example.new :language => 'Foo'
+      example.language.should == 'Foo'
+    end
+
+    it "should set the content if given" do
+      example = ApiGuides::Example.new :content => 'Foo'
+      example.content.should == 'Foo'
+    end
+  end
+end

data/spec/lib/generator_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe ApiGuides::Generator do
+  before(:each) do
+    File.open RSpec.support_path.join("test_guide.xml"), "w" do |file|
+      file.puts %Q{
+        <document>
+          <title>Using ApiGuides</title>
+          <position>1</position>
+          <section title="The Generator">
+            <docs>Docs</docs>
+            <reference title="Method Signature">Foobar</reference>
+            <examples>
+              <example language="ruby">ruby examples</example>
+              <example language="python">python examples</example>
+            </examples>
+          </section>
+        </document>
+      }
+    end
+  end
+
+  before(:each) do
+    ApiGuides::Generator.new({
+      :site_path => RSpec.tmp_path,
+      :source_path => RSpec.support_path,
+      :title => 'Test Guides',
+      :default => 'ruby'
+    }).generate
+  end
+
+  it "should generate a ruby file" do
+    File.exists?(RSpec.tmp_path.join("ruby.html")).should be_true
+  end
+
+  it "should generate a python file" do
+    File.exists?(RSpec.tmp_path.join("python.html")).should be_true
+  end
+
+  it "should copy over the main css" do
+    File.exists?(RSpec.tmp_path.join("style.css")).should be_true
+  end
+
+  it "should copy over the syntax css" do
+    File.exists?(RSpec.tmp_path.join("syntax.css")).should be_true
+  end
+end

data/spec/lib/markdown_helper_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+class StringAligner
+  include ApiGuides::MarkdownHelper
+end
+
+describe StringAligner do
+  let(:indented_string) do
+    %Q{
+      # This String is intended in the source
+
+      Its lines are underneath it.
+
+      It may have some code too like this:
+
+          def this_method(arg)
+            puts arg
+          end
+
+      There may also be intended lists!
+
+        * Value
+        * Value
+          * Value
+
+      This should shift it all to the left and align
+      all lines with the leading line
+    }
+  end
+
+  let(:aligned_string) do
+    %Q{
+# This String is intended in the source
+
+Its lines are underneath it.
+
+It may have some code too like this:
+
+    def this_method(arg)
+      puts arg
+    end
+
+There may also be intended lists!
+
+  * Value
+  * Value
+    * Value
+
+This should shift it all to the left and align
+all lines with the leading line
+    }
+  end
+
+  it "should align the string" do
+    subject.left_align(indented_string).should == aligned_string
+  end
+end

data/spec/lib/reference_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe ApiGuides::Reference do
+  describe ".from_xml" do
+    let(:xml) { %Q{<reference title="Foo">bar</reference>} }
+
+    subject { ApiGuides::Reference.from_xml(xml) }
+
+    its(:title) { should == 'Foo' }
+
+    its(:content) { should == 'bar' }
+  end
+
+  describe "#initialize" do
+    it "should set the title if given" do
+      reference = ApiGuides::Reference.new :title => 'Foo'
+      reference.title.should == 'Foo'
+    end
+
+    it "should set the content if given" do
+      reference = ApiGuides::Reference.new :content => 'Foo'
+      reference.content.should == 'Foo'
+    end
+  end
+end

data/spec/lib/section_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe ApiGuides::Section do
+  describe ".from_xml" do
+    let(:xml) do
+      %Q{
+        <section title="Foo">
+          <docs>docs</docs>
+          <reference title="Bar">
+            <![CDATA[
+            Insert your markdown here
+            ]]>
+          </reference>
+          <examples>
+            <example language="ruby">
+              <![CDATA[
+              Insert your markdown here>
+              ]]>
+            </example>
+          </example>
+        </section>
+      }
+    end
+
+    let(:example) { double('Example') }
+    let(:reference) { double('Reference') }
+
+    before(:each) do
+      ApiGuides::Example.should_receive(:from_xml).and_return(example) 
+      ApiGuides::Reference.should_receive(:from_xml).and_return(reference) 
+    end
+
+    subject { ApiGuides::Section.from_xml(xml) }
+
+    its(:title) { should == 'Foo' }
+
+    its(:docs) { should == 'docs' }
+
+    its(:examples) { should == [example] }
+
+    its(:reference) { should == reference }
+  end
+
+  describe "#initialize" do
+    it "should set the title if given" do
+      section = ApiGuides::Section.new :title => 'Foo'
+      section.title.should == 'Foo'
+    end
+
+    it "should set the docs if given" do
+      section = ApiGuides::Section.new :docs => 'Foo'
+      section.docs.should == 'Foo'
+    end
+
+    it "should set the reference if given" do
+      section = ApiGuides::Section.new :reference => 'reference'
+      section.reference.should == 'reference'
+    end
+
+    it "should set the examples if given" do
+      section = ApiGuides::Section.new :examples => []
+      section.examples.should == []
+    end
+  end
+end

data/spec/lib/views/document_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe ApiGuides::Views::Document do
+  include ApiGuides::MarkdownHelper
+
+  let(:document) { double('Document', :title => 'A Title', :sections => []) }
+
+  subject { described_class.new document }
+
+  its(:title) { should == document.title }
+
+  its(:id) { should == 'd-a-title' }
+
+  its(:sections) { should be_a(Array) }
+end

data/spec/lib/views/example_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe ApiGuides::Views::Example do
+  include ApiGuides::MarkdownHelper
+
+  let(:example) { double('Example', :content => 'content') }
+
+  subject { described_class.new example }
+
+  its(:content) { should == markdown(example.content) }
+end

data/spec/lib/views/reference_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe ApiGuides::Views::Reference do
+  include ApiGuides::MarkdownHelper
+
+  let(:reference) { double('Reference', :title => 'A Title', :content => 'content') }
+
+  subject { described_class.new reference }
+
+  its(:title) { should == reference.title }
+
+  its(:id) { should == 'r-a-title' }
+
+  its(:content) { should == markdown(reference.content) }
+end

data/spec/lib/views/section_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe ApiGuides::Views::Section do
+  include ApiGuides::MarkdownHelper
+
+  let(:reference) { double('Reference') }
+  let(:example) { double('Example') }
+
+  let(:section) do
+    double('Section', 
+           :title => 'A Title', 
+           :docs => 'content',
+           :reference => reference,
+           :examples => [example])
+  end
+
+  subject { described_class.new section}
+
+  its(:title) { should == section.title }
+
+  its(:id) { should == 's-a-title' }
+
+  its(:docs) { should == markdown(section.docs) }
+
+  it "should be able to handle empty docs" do
+    view = described_class.new double('Section', :docs => nil)
+    view.docs.should be_nil
+  end
+
+  its(:reference) { should be_a(ApiGuides::Views::Reference) }
+
+  its(:examples) { should be_a(Array) }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+$: << File.expand_path("../../lib", __FILE__)
+
+require 'simplecov'
+SimpleCov.start
+
+require 'api_guides'
+require 'pathname'
+
+module RSpec
+  def self.support_path
+    Pathname.new "#{File.dirname(__FILE__)}/support"
+  end
+
+  def self.tmp_path
+    Pathname.new "#{File.dirname(__FILE__)}/tmp"
+  end
+end
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  config.fail_fast = true
+
+  config.before :each do
+    FileUtils.rm_rf RSpec.support_path.join("*")
+    FileUtils.rm_rf RSpec.tmp_path.join("*")
+  end
+end
+

data/spec/support/test_guide.xml

@@ -0,0 +1,14 @@
+
+        <document>
+          <title>Using ApiGuides</title>
+          <position>1</position>
+          <section title="The Generator">
+            <docs>Docs</docs>
+            <reference title="Method Signature">Foobar</reference>
+            <examples>
+              <example language="ruby">ruby examples</example>
+              <example language="python">python examples</example>
+            </examples>
+          </section>
+        </document>
+      

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: api_guides
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Hawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: &70144284744740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144284744740
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70144284744220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144284744220
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70144284743800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144284743800
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70144284743260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144284743260
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70144284742840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144284742840
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70144284742380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70144284742380
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70144284741960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70144284741960
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70144284741540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70144284741540
+description: Generate HTML documentation for your program with markdown and examples
+  for different languages.
+email:
+- me@broadcastingadam.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- api_guides.gemspec
+- lib/api_guides.rb
+- lib/api_guides/document.rb
+- lib/api_guides/example.rb
+- lib/api_guides/generator.rb
+- lib/api_guides/markdown_helper.rb
+- lib/api_guides/reference.rb
+- lib/api_guides/resources/style.css
+- lib/api_guides/resources/syntax.css
+- lib/api_guides/section.rb
+- lib/api_guides/templates/page.mustache
+- lib/api_guides/version.rb
+- lib/api_guides/view_helper.rb
+- lib/api_guides/views/document.rb
+- lib/api_guides/views/example.rb
+- lib/api_guides/views/page.rb
+- lib/api_guides/views/reference.rb
+- lib/api_guides/views/section.rb
+- readme.md
+- spec/lib/document_spec.rb
+- spec/lib/example_spec.rb
+- spec/lib/generator_spec.rb
+- spec/lib/markdown_helper_spec.rb
+- spec/lib/reference_spec.rb
+- spec/lib/section_spec.rb
+- spec/lib/views/document_spec.rb
+- spec/lib/views/example_spec.rb
+- spec/lib/views/reference_spec.rb
+- spec/lib/views/section_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_guide.xml
+homepage: https://github.com/threadedlabs/api_guides
+licenses: []
+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.11
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/lib/document_spec.rb
+- spec/lib/example_spec.rb
+- spec/lib/generator_spec.rb
+- spec/lib/markdown_helper_spec.rb
+- spec/lib/reference_spec.rb
+- spec/lib/section_spec.rb
+- spec/lib/views/document_spec.rb
+- spec/lib/views/example_spec.rb
+- spec/lib/views/reference_spec.rb
+- spec/lib/views/section_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_guide.xml