content_directory 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmViMTg4NTkxYTIyNWFlNDA1MDhmYTM1YjQ2MzgxNjFiNWNmODE1Zg==
+    YWQyZDYxMDlmMjI1ODg3YjgzM2UyNmRlYjBlY2U5Y2YxYTE0YzZlNw==
   data.tar.gz: !binary |-
-    ZmZlMTk2YjE3M2IyZTY1MTVhNjQ2MTI5NDY1OTQyODVmNmNlMDcwOQ==
+    ZWNmZjYxOWJjMTUwNGQxYzM1MWVmN2ZkYzA4YjAzOTE5ZmI2Yzc3ZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MTkyMjIyMzEwNTRkYzg0YjEzMWZlZGYzMWM5MzI3YmMwZmVmOTE2MzExMmFk
-    NTdmNmIyOTQyZWVmOTViYzRhZTNiOThhOTQ0ODM1ZTNiZjBkN2FhZTg4YzY1
-    ZjQzZTY5MmMxMGM5NTJjYTk5ZTY4NDMwMDg2N2FiMThhZTMyZTk=
+    MWUxYzM2MjBmNGEyZDRhYWFiZGU0ZjMzNmRmNzc2ZmU3MzllODU4NmE0ZmQz
+    NDNmZWYxNWE4NWQwODM4YmNhMzY1MDExNGZiMDIwYWI4Yjg2MDk4NWQ2Zjkw
+    MTY0YzBhOGQ5NGYwM2Q0MmZjY2Y3N2VhODMzYTBmZDJkNDI0YTI=
   data.tar.gz: !binary |-
-    MjhjNDBmNDFmOWZhOTIzODc5ZGQ2YTZlZjBjMTg2NGM2YzViNTI1MmY1M2Ew
-    MzA5MDZiYmYxZjI5NDAxNWFhMDcxMjBkN2VjOTMxMzhiZjQwODZkMzNlYzhh
-    YjcwMDY4OGE0NThlODEyOWY5ZTM5YjczNTBhNzE0MTA0M2EwN2U=
+    YWExNGRkZGRjM2U1NWQ3MzdjY2E1MGI4MDJjN2Q5MTA3NjEwZjM2Y2M3ZTEy
+    OTMwZmQ1ODE5ZThlMDQ3NTZmMTk3ZjFjMTk2NmZkMTFhN2FiNGI1NTc1ZmYz
+    NjEwN2FlYTUxODY2M2M1YWVkODRkZTZiY2ZjY2EzYzAxOTVjNDM=

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.1.1
+
+- An entry file, which only contains metadata, now returns `text` and `html` as nil
+
+## 0.1.0
+
+- Initial release

data/README.md

@@ -1,12 +1,73 @@
-# ContentDirectory
+# Content Directory
 
-TODO: Write a gem description
+Content Directory is a lightweight replacement of Content Management System. It provides structure for text based content. It comes with a parser, which allows content entries to have metadata and rich formatting.
+
+## Structure
+
+Content Directory does not require a database. Instead, it uses file system. An entry is a file written in Markdown syntax. You can group related entries in a folder.
+
+    - content
+      - home
+        - main.md
+        - features
+          - collaboration.md
+          - manage.md
+      - posts
+        - a-new-blog.md
+        - sortable-stars.md
+  
+## Writing entries
+
+Entry uses Markdown syntax, but there is an additional rule that every entry must have a metadata declaration on the top. Metadata declaration block uses YAML syntax.
+
+    Title: Introduction
+    Date: 2013/03/10
+    Tags: ["post", "short"]
+
+    It was a bright cold day in April, and the clocks were striking
+    thirteen. Winston Smith, his chin nuzzled into his breast in an
+    effort to escape the vile wind, slipped quickly through the
+    glass doors of *Victory Mansions*, though not quickly enough to
+    prevent a swirl of gritty dust from entering along with him. 
+
+    The hallway smelt of boiled cabbage and old rag mats. At one end
+    of it a coloured poster, too large for indoor display, had been
+    tacked to the wall. It depicted simply an **enormous** face,
+    more than a metre wide: the face of a man of about forty-five,
+    with a heavy black moustache and ruggedly handsome features.
+
+## Reading entries
+
+Once you have written entries, you can use `ContentDirectory.find` to get the processed entries and render them into views.
+
+`ContentDirectory.find` returns a `Hash` of `ContentDirectory::Entry`. It accepts one argument, which is a path relative to `ContentDirectory.root`. If path is not specified, `ContentDirectory.find` will find all possible entries.
+
+    posts = ContentDirectory.find "posts"
+
+You can use metadata to sort posts by date
+
+    posts = ContentDirectory.find("posts").values
+    posts.sort_by! { |post| post.metadata["Date"] }
+
+Entry has three important values: `metadata`, `text`, `html`. 
+
+1. `metadata` is a `Hash` of parsed metadata block from entry file. 
+2. `text` is a `String` of original entry text. 
+3. `html` is a `String` of the result of original text after processed by Redcarpet Markdown parser.
+
+You can you these three values to render entry to a view.
+
+    for post in posts
+      puts post.metadata["Title"]
+      puts post.text
+      puts post.html
+    end
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'content_directory'
+    gem "content_directory"
 
 And then execute:
 
@@ -16,9 +77,24 @@ Or install it yourself as:
 
     $ gem install content_directory
 
-## Usage
+## Configuration
+
+ContentDirectory.root is default to `"#{Rails.root}/content"` when used in Rails. If you want to use other directory, you can easily change it in the initializer.
+
+    ContentDirectory.root = "path/to/content"
+
+## Use with Rails
+
+Content Directory is intended to be used in Rails to extract content from view templates. In this fashion, content can be easily reused and queried.
+
+1. Create `content` directory in Rails root path.
+2. Write entries in this directory. 
+3. Use `ContentDirectory.find` in the controllers. 
+4. Render entry `html` or `text` in the templates.
+
+## Test
 
-TODO: Write usage instructions here
+    rake test
 
 ## Contributing
 

data/content_directory.gemspec

@@ -1,16 +1,16 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'content_directory/version'
+require "content_directory/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "content_directory"
   spec.version       = ContentDirectory::VERSION
   spec.authors       = ["Steve Randy Tantra"]
   spec.email         = ["steve.randy@gmail.com"]
-  spec.description   = ""
-  spec.summary       = ""
-  spec.homepage      = ""
+  spec.description   = "Content Directory is a lightweight replacement of Content Management System. It provides structure for text based content. It comes with a parser, which allows content entries to have metadata and rich formatting."
+  spec.summary       = "Lightweight replacement of Content Management System"
+  spec.homepage      = "https://github.com/steverandy/content_directory"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/content_directory/entry.rb

@@ -8,17 +8,17 @@ module ContentDirectory
     def initialize(path)
       @path = path
       @text = File.read "#{ContentDirectory.root}/#{@path}"
-      @metadata = @text.split("\n\n").first
+      @metadata, @text = @text.split("\n\n", 2)
 
       begin
         @metadata = YAML.load @metadata
-        @text = @text.split("\n\n", 2).last
       rescue Exception => e
         @metadata = nil
       end
     end
 
     def html
+      return nil unless @text
       markdown = Redcarpet::Markdown.new Redcarpet::Render::HTML
       html = markdown.render @text
       Redcarpet::Render::SmartyPants.render html

data/lib/content_directory/version.rb

@@ -1,3 +1,3 @@
 module ContentDirectory
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/support/content/home/empty.md

@@ -0,0 +1 @@
+Title: Empty

data/test/unit/content_directory_test.rb

@@ -19,7 +19,7 @@ class ContentDirectoryTest < ActiveSupport::TestCase
     assert_equal 2, content.length
 
     home = ContentDirectory.find "home"
-    assert_equal 2, home.length
+    assert_equal 3, home.length
     assert_equal 2, home["features"].length
     assert_kind_of ContentDirectory::Entry, home["main"]
   end

data/test/unit/entry_test.rb

@@ -1,7 +1,7 @@
 require "test_helper"
 
 class EntryTest < ActiveSupport::TestCase
-  test "entry" do
+  test "entry with metadata and text" do
     ContentDirectory.root = File.expand_path("../../support/content", __FILE__)
     home = ContentDirectory.find "home"
     main = home["main"]
@@ -11,4 +11,15 @@ class EntryTest < ActiveSupport::TestCase
     assert_equal "Build software better, together.\n\nPowerful collaboration, review, and code management for open source and private development projects.\n", main.text
     assert_equal "<p>Build software better, together.</p>\n\n<p>Powerful collaboration, review, and code management for open source and private development projects.</p>\n", main.html
   end
+
+  test "entry with metadata and no text" do
+    ContentDirectory.root = File.expand_path("../../support/content", __FILE__)
+    home = ContentDirectory.find "home"
+    empty = home["empty"]
+    assert_kind_of ContentDirectory::Entry, empty
+    assert_equal "Empty", empty.metadata["Title"]
+    puts empty.text
+    assert_nil empty.text
+    assert_nil empty.html
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: content_directory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Steve Randy Tantra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-10 00:00:00.000000000 Z
+date: 2013-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -66,7 +66,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+description: Content Directory is a lightweight replacement of Content Management
+  System. It provides structure for text based content. It comes with a parser, which
+  allows content entries to have metadata and rich formatting.
 email:
 - steve.randy@gmail.com
 executables: []
@@ -74,6 +76,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -82,6 +85,7 @@ files:
 - lib/content_directory.rb
 - lib/content_directory/entry.rb
 - lib/content_directory/version.rb
+- test/support/content/home/empty.md
 - test/support/content/home/features/collaboration.md
 - test/support/content/home/features/manage.md
 - test/support/content/home/main.md
@@ -90,7 +94,7 @@ files:
 - test/test_helper.rb
 - test/unit/content_directory_test.rb
 - test/unit/entry_test.rb
-homepage: ''
+homepage: https://github.com/steverandy/content_directory
 licenses:
 - MIT
 metadata: {}
@@ -113,8 +117,9 @@ rubyforge_project:
 rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Lightweight replacement of Content Management System
 test_files:
+- test/support/content/home/empty.md
 - test/support/content/home/features/collaboration.md
 - test/support/content/home/features/manage.md
 - test/support/content/home/main.md