slimdown 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a18c7d342957dba4bfd26086316993977ec27652
-  data.tar.gz: 81116d6930839e2829ce713aed894106a975baed
+  metadata.gz: e671937e7916385a1feec7b84f7cf86d18514d9d
+  data.tar.gz: 8f60d40358a09a4cdf795b190b82a4adb023b045
 SHA512:
-  metadata.gz: 035581363772bb4b85085721940d462538955d6d8b295be8f306b196bd68a537d60c660ad035c98d12ec6a911410237de4d9691d566197441ce947381ece0917
-  data.tar.gz: 526d795675fc88661767adb10a6c107c8237a02aa7714a73adb62b82a476fc7a42180c3ddf72cbc822c59b4bc6251f39c38f8bd79cab98e8c04a4ab0d4e34fe6
+  metadata.gz: 1a1d57e1f8e984498afa4056851096bddbf137e75871d2a0d78f74a8a4c9048ae3e59e9d80a23a20f40f8ef46458b07675d8dce4cd2868716eed46f266d97638
+  data.tar.gz: 5cc03ddfd79fa58717cada275c5ca589ebd468adebca8240b3877de1a72742d146586857eab65b0488ab23ad2499bd30098685dead9a9d9dd3a4c50be5f5add3

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-03-13)
+[`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,49 @@ 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 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.
 
-    Slimdown.config do |c|
-      c.location = Rails.root.join('lib/pages')
-    end
+```ruby
+Slimdown.config do |c|
+  c.location = Rails.root.join('lib/pages')
+end
+```
 
 ## Testing
 

data/lib/slimdown/page.rb

@@ -1,7 +1,6 @@
 module Slimdown
   # The model representing a page
   class Page
-
     # The title from the document headers
     attr_reader :title
     # The template from the document headers
@@ -61,25 +60,28 @@ 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

data/lib/slimdown/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimdown
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - William Johnston
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-13 00:00:00.000000000 Z
+date: 2017-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -119,6 +119,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - ".yardocops"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -154,8 +155,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A system for using static Markdown for pages.
 test_files: []
+has_rdoc: