slimdown 0.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97a5dcee1b610ec49bd18729012ecb80fcf4732b
-  data.tar.gz: c9257a530cc9fc29b3865dba758906e1704df776
+SHA256:
+  metadata.gz: 3e845fd99a6108c1c7553637a96316710d824d93df0122260490363a2d91605d
+  data.tar.gz: a95a0cb693ed000c5881ea6d055f218180a3617f7c6adcdb95732053719f84b6
 SHA512:
-  metadata.gz: 85cd40427c316a0c3d224ceb3fe7475352c62ef3d4f666b06a9c8b8fc44bfcb427e396ba9c198a40ab44b276486e5bfad06aa05bbe17b339402e76d074161f82
-  data.tar.gz: f4f5ae9fd9c67402468d4f6c77327f79de8e8f37f208306695ad0404e5232c944eef5e484d4f114f1f612de3c9de9dc29824fa546ad2fec43d7b396953b3271d
+  metadata.gz: 20d859648791b40e2c65276582d55f4fdc68dffc61c5620cb1b9d74faf471c2841498a2a5f3df516faa03845de9e11ecabb19b001619cce4a505b3cc110c6e0c
+  data.tar.gz: c0a24227009eda9d6538af0130d867d920c9ea6b120f51fa1feeb03c0fe98e8f87e23a1dedf64f928253e5909a1d07a325e31e23be16bf31b3edcd898266a71b

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
 cache: bundler
 rvm:
-  - 1.9.3
-  - 2.1.5
-  - 2.2.2
-  - jruby
+  - 2.2.3
+  - 2.3.1
+  # - jruby
 before_install:
   - gem update --system
   - gem --version

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Ruby Slimdown Changelog
+
+## [master]
+[master]: https://github.com/APMG/ruby-slimdown/compare/1.1.0...HEAD
+
+* Your contribution here!
+
+## [`1.1.0`] (2017-12-04)
+[`1.1.0`]: https://github.com/APMG/ruby-slimdown/compare/1.0.2...1.1.0
+
+* [#2](https://github.com/APMG/ruby-slimdown/pull/2): Added page parent method.
+* [#3](https://github.com/APMG/ruby-slimdown/pull/3): Fixed mutation of `@absolute_path` in `Page`.
+
+## [`1.0.2`] (2017-03-13)
+[`1.0.2`]: https://github.com/APMG/ruby-slimdown/compare/1.0.1...1.0.2
+
+* Add support for arbitrary frontmatter via `Page#headers` method.
+
+## [`1.0.1`] (2015-07-07)
+[`1.0.1`]: https://github.com/APMG/ruby-slimdown/compare/1.0.0...1.0.1
+
+* Fix for case where no frontmatter.
+
+## [`1.0.0`] (2015-06-23)
+[`1.0.0`]: https://github.com/APMG/ruby-slimdown/compare/0.1.2...1.0.0
+
+* Same as 0.1.2, but marking as v1.0.0 to indicate SemVer support.
+
+## [`0.1.2`] (2015-06-18)
+[`0.1.2`]: https://github.com/APMG/ruby-slimdown/compare/0.1.1...0.1.2
+
+* Support hard line breaks with `<br />`.
+
+## [`0.1.1`] (2015-06-16)
+[`0.1.1`]: https://github.com/APMG/ruby-slimdown/compare/0.1.0...0.1.1
+
+* Don't assume files in `pages/`.
+* Indicate required Ruby version.
+
+## [`0.1.0`] (2015-06-15)
+[`0.1.0`]: https://github.com/APMG/ruby-slimdown/compare/c1c7481d493c444529fe40082fc23b935f20c55b...0.1.0
+
+* Initial release

data/README.md

@@ -28,41 +28,76 @@ Or install it yourself as:
 To add to your app, create a controller with one action, such as `show`. In that
 action, add code to pull in the action:
 
-    class SlimdownController < ApplicationController
-      def show
-        @page = Slimdown::Page.find(params[:slug])
-      end
-    end
+```ruby
+class SlimdownController < ApplicationController
+  def show
+    @page = Slimdown::Page.find(params[:slug])
+  end
+end
+```
 
 Then add a view for the show action.
 
-    <%= @page.body.to_html.html_safe %>
-
-    <h2>Sibling Pages</h2>
-    <ul>
-      <% @page.siblings.each do |sibling| %>
-        <li><%= link_to sibling.title, "/#{sibling.path}" %></li>
-      <% end %>
-    </ul>
-
-    <h2>Child Pages</h2>
-    <ul>
-      <% @page.children.each do |child| %>
-        <li><%= link_to child.title, "/#{child.path}" %></li>
-      <% end %>
-    </ul>
+```erb
+<%= @page.body.to_html.html_safe %>
+
+<h2>Sibling Pages</h2>
+<ul>
+  <% @page.siblings.each do |sibling| %>
+    <li><%= link_to sibling.title, "/#{sibling.path}" %></li>
+  <% end %>
+</ul>
+
+<h2>Child Pages</h2>
+<ul>
+  <% @page.children.each do |child| %>
+    <li><%= link_to child.title, "/#{child.path}" %></li>
+  <% end %>
+</ul>
+```
 
 Add a route to direct all unhandled requests to your controller. Make sure that
-it is at the end of your routes.rb so it doesn't superseed other routes.
+it is at the end of your routes.rb so it doesn't supersede other routes.
 
-    get '/*slug', to: 'slimdown#show'
+```ruby
+get '/*slug', to: 'slimdown#show'
+```
 
 Finally, add an initializer in `config/initializers/slimdown.rb` to set the path
 to your pages.
 
+```ruby
+Slimdown.config do |c|
+  c.location = Rails.root.join('lib/pages')
+end
+```
+
+## Testing
+
+Testing using a controller spec is not possible because you are testing for an
+arbitrary url. You can do a feature test with Capybara or friends. However,
+given that you are just returning content, you can use a request spec. For
+example, you have an about.md in your remote repo or lib/pages then in your
+spec/requests/slimdown_request_spec.rb. Additionally, you can override the page
+path for the test, allowing you to use a fixture directory.
+
+```ruby
+RSpec.describe "Static Pages", type: :request do
+  before :each do
     Slimdown.config do |c|
-      c.location = Rails.root.join('lib/pages')
+      c.location = Rails.root.join '/spec/fixtures/test_pages'
+    end
+  end
+
+  describe "GET /" do
+    it "#show" do
+      get "/about"
+      expect(response).to render_template(:show)
+      expect(response.status).to be(200)
     end
+  end
+end
+```
 
 
 ## General notes

data/lib/slimdown/exception.rb

@@ -1,5 +1,6 @@
 module Slimdown
   # Exception class for Slimdown errors.
+  # TODO: On a major SemVer change, migrate to PageNotFoundException.
   class Exception < StandardError
   end
 end

data/lib/slimdown/page.rb

@@ -1,11 +1,12 @@
 module Slimdown
   # The model representing a page
   class Page
-
     # The title from the document headers
     attr_reader :title
     # The template from the document headers
     attr_reader :template
+    # All the document headers
+    attr_reader :headers
 
     # Get new page object
     #
@@ -59,30 +60,33 @@ module Slimdown
     # @return [Array<Slimdown::Page>] a list of child pages.
     def children
       # Check to see whether dir exists.
-      folder = @absolute_path
-      folder.slice! '.md'
+      Slimdown::Folder.new(@absolute_path.chomp('.md')).pages
+    end
 
-      Slimdown::Folder.new(folder).pages
+    # The parent of this document
+    #
+    # @return [<Slimdown::Page>|nil] the parent, if it exists
+    def parent
+      parent = File.expand_path('..', @absolute_path).concat('.md')
+
+      return nil unless File.file?(parent)
+
+      Slimdown::Page.new(parent)
     end
 
     # The relative path for this document.
     #
     # @return [String] the relative path, e.g. 'about/contact'
     def path
-      loc = Slimdown.config.location
-      relative = @absolute_path
-      relative.slice! "#{loc}/"
-      relative.slice! '.md'
-
-      relative
+      @absolute_path.sub(%r{^#{Slimdown.config.location}/(.*)\.md}, '\1')
     end
 
-  private
+    private
 
     def load_headers
-      headers = @parsed_page.headers
-      @title = headers['title']
-      @template = headers['template']
+      @headers = @parsed_page.headers
+      @title = @headers['title']
+      @template = @headers['template']
     end
   end
 end

data/lib/slimdown/page_parser.rb

@@ -21,7 +21,10 @@ module Slimdown
     #
     # @return [Hash] document headers
     def headers
-      YAML.load @header_text
+      head = {}
+      head = YAML.load @header_text unless @header_text == ''
+
+      head
     end
 
     # The parsed markdown document body.
@@ -48,7 +51,7 @@ module Slimdown
             part = :body
           elsif part == :header
             @header_text += line
-          elsif part == :body
+          elsif part == :body || part == nil
             @body_text += line
           end
         end

data/lib/slimdown/version.rb

@@ -1,4 +1,4 @@
 module Slimdown
   # The slimdown version
-  VERSION = '0.1.2'
+  VERSION = '1.2.0'.freeze
 end

data/ruby-slimdown.gemspec

@@ -21,12 +21,12 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.3'
 
-  spec.add_runtime_dependency 'kramdown', '~> 1.7'
+  spec.add_runtime_dependency 'kramdown', '~> 2.3'
 
   spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "guard", "~> 2.12"
   spec.add_development_dependency "guard-rspec", "~> 4.5"
   spec.add_development_dependency "pry", "~> 0.10"
-  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "yard", "~> 0.9.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimdown
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - William Johnston
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
 description: A system for using Markdown from a folder and turning it into web pages.
 email:
 - wjohnston@mpr.org
@@ -119,6 +119,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - ".yardocops"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -153,10 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A system for using static Markdown for pages.
 test_files: []
-has_rdoc: