content_driven 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3403e03f4fc413624e8ce2e5f2d73bd279bc83c
+  data.tar.gz: 6b0d0ab09da151ba396bae5eb3700c5b025ddd0f
+SHA512:
+  metadata.gz: a3d3a1724d30c2bd7ee8f5ef159894ee2eff2b374d815345b1a40794101b9b19ec9989ca0673ae85473a493330147e72bf396486ebffa878000af29e65c109cf
+  data.tar.gz: a33a5eb1b9435cfa87c0d719df4eca2d49a99acdfd7c129c8264793f5393c1a8076825af847a4d8d343e2733cc74d19e2d90b3f1197097c7084912256c311b29

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sodium.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nicholas Johnson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# Content Driven Gem
+
+A super clean DLS for defining blogs and websites with an emphasis on clean **Information Architecture**, sensible **Metadata** and **SEO**. Filesystem based so no database required. Works with any Ruby framework but plays especially nicely with Sinatra.
+
+Aimed at developers. Define your site architecture using the simple Ruby DSL. Write your content in HAML, Markdown, ERB, whatever suits. Push to Heroku and you're live!
+
+Create custom content types simply by subclassing ContentDriven::Page. The DSL will learn and adapt.
+
+Define your site using calls like blog_post :post_title.
+
+## No database
+
+I blog on the train. I have no network access, so no access to a remote CMS. I wanted to be able to write my blog posts in HAML, and store them in a Git repository.
+
+I wrote Stripes to help me do that.
+
+## Sinatra
+
+Stripes will work with any Ruby framework from Camping to Rails, but plays especially well with Sinatra. If you'd like to use Sinatra, check out the Stripes_sinatra gem instead. (note: not yet available)
+
+## Heroku
+
+Stripes is fully compatible with Heroku. Get your blog live in minutes on Heroku free tier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'content_driven'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install content_driven
+
+## Usage
+
+Define your website like so
+
+    @website = ContentDriven::Site.new do
+      add_blog :my_blog do
+        add_post :rule_world
+          self.title = "How to Rule the World with Ruby"
+        end
+        add_post :build_awesome
+          self.title = "How to build more awesome"
+        end
+      end
+    end
+
+You'll get back an object of class Website which you can then query like so:
+
+    # Get the default blog
+    @blog = @website.blog
+
+    # Get a blog by key if you have more than one
+    @website.blog[:by_blog]
+
+    # Get the posts for a blog
+    @website.blog.posts
+
+    # Get the first blog post
+    @website.blog.first_post
+
+## Adding additional content types
+
+Add additional content types by subclassing Stripes::Page. eg.
+
+    class Product < Stripes::Page
+      attr_accessor :price
+    end
+
+You can now call methods like this:
+
+    site = Stripes::Site do
+      add_product :kitty do
+        self.title = "Teeny black kitten"
+        self.price = 5.99
+      end
+    end
+
+    site.products.length
+    # => 1
+
+    site.product[:kitty]
+    # => Product
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/content_driven.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'content_driven/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "content_driven"
+  spec.version       = ContentDriven::VERSION
+  spec.authors       = ["Nicholas Johnson"]
+  spec.email         = ["nicholas@forwardadvance.com"]
+  spec.description   = %q{A clean, simple DSL for defining websites, no database required}
+  spec.summary       = %q{Emphasised great Information Architecture, Metadata and SEO. Define your website using the simple Ruby DSL. Build your pages in HAML, ERB, MD, etc. Deploy via git.}
+  spec.homepage      = "http://www.github.com/forwardadvance/content_driven"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "activesupport"
+end

data/lib/content_driven/blog.rb

@@ -0,0 +1,14 @@
+require_relative 'page'
+
+module ContentDriven
+
+  class Blog < Page
+    # TODO: Convenience shorthand methods
+    # alias_method :add_post,  :add_blog_post
+    # alias_method :next_post, :next_blog_post
+    # alias_method :prev_post, :prev_blog_post
+    # alias_method :post,      :blog_post
+    # alias_method :last_post, :last_blog_post
+    # alias_method :last_post, :last_blog_post
+  end
+end

data/lib/content_driven/blog_post.rb

@@ -0,0 +1,4 @@
+module ContentDriven
+  class BlogPost < Page
+  end
+end

data/lib/content_driven/dsl.rb

@@ -0,0 +1,31 @@
+require 'active_support/core_ext/string'
+
+module ContentDriven
+  # Extends ContentDriven with methods to create content of all the types it knows about
+  module DSL
+
+    # Dynamically extend the DSL when we subclass Page
+    def define_dsl_for(subclass)
+      class_name = subclass.to_s.split("::").last.camelcase.underscore
+
+      # Allows us to call methods like site.blogs and blog.blog_posts
+      define_method("get_#{class_name.pluralise}") do
+        children.dup.delete_if do |child|
+          !children[child].is_a? subclass
+        end
+      end
+
+      # Allows us to call methods like site.get_blog which will return the first blog
+      define_method("get_#{class_name}") do |url=nil|
+        send("get_#{class_name.pluralise}")[url]
+      end
+
+      # Allows us to call methods like site.add_blog and blog.add_blog_posts
+      define_method "add_#{class_name}" do |key=nil, &block|
+        content_class = ContentDriven.const_get class_name.to_s.camelcase
+        child = content_class.new &block
+        add_child(key, child)
+      end
+    end
+  end
+end

data/lib/content_driven/page.rb

@@ -0,0 +1,55 @@
+require_relative "support"
+require_relative "dsl"
+require_relative "page_list"
+require_relative "routes"
+require 'active_support/core_ext/string'
+
+module ContentDriven
+
+  # ContentDriven defines a tree of content. Page is the base class.
+  # A Page has a parent and zero or more children
+  class Page
+    attr_accessor :parent, :children, :url, :title, :date
+
+    extend ContentDriven::DSL
+    include ContentDriven::Routes
+
+    # Extend the DSL when Page is subclasses
+    def self.inherited(subclass)
+      define_dsl_for(subclass)
+    end
+
+    def initialize &block
+      self.children = PageList.new
+      if block_given?
+        self.instance_eval &block
+      end
+    end
+
+    # Add a child page. You will seldom need to call this directly.
+    # Instead use add_blog or add_article
+    def add_child key, page = nil
+      if key.is_a? Page
+        page, key = key, (children.keys.length + 1).to_sym
+      end
+      page.parent = self
+      page.url = key
+      children[key] = page
+    end
+
+    # Is this a root page, i.e. it has no parent?
+    def root?
+      self.parent.nil?
+    end
+
+    # Returns the URL fragment as a symbol, or :root if it is the root page
+    def to_sym
+      if root?
+        return :root
+      else
+        return self.url.to_sym
+      end
+    end
+
+  end
+end

data/lib/content_driven/page_list.rb

@@ -0,0 +1,19 @@
+module ContentDriven
+  class PageList < Hash
+
+    # TODO: Add methods like this:
+    # def last_blog_post
+    #   blog_posts.values.last
+    # end
+
+    # def next_blog_post key
+    #   keys = post.keys
+    #   self.posts[keys[keys.index_of(key) + 1]]
+    # end
+
+    # def prev_blog_post key
+    #   keys = post.keys
+    #   self.posts[keys[keys.index_of(key) + 1]]
+    # end
+  end
+end

data/lib/content_driven/routes.rb

@@ -0,0 +1,13 @@
+module ContentDriven
+  module Routes
+    # Walks the tree based on a url and returns the requested page
+    # Will return nil if the page does not exist
+    def content_for route
+      parts = route.split("/").delete_if &:empty?
+      content = parts.inject(self) do |page, part|
+        page.children[part.to_sym] if page
+      end
+      content
+    end
+  end
+end

data/lib/content_driven/site.rb

@@ -0,0 +1,4 @@
+module ContentDriven
+  class Site < Page
+  end
+end

data/lib/content_driven/support.rb

@@ -0,0 +1,14 @@
+class String
+  def underscore
+    self.downcase
+  end
+  def pluralise
+    self + "s"
+  end
+end
+
+class Fixnum
+  def to_sym
+    self.to_s.to_sym
+  end
+end

data/lib/content_driven/tag.rb

@@ -0,0 +1,4 @@
+module ContentDriven
+  class Tag < Page
+  end
+end

data/lib/content_driven/tag_cloud.rb

@@ -0,0 +1,9 @@
+module ContentDriven
+  class TagCloud < Page
+    attr_accessor :tags
+    def initialize
+      tags = {}
+      super
+    end
+  end
+end

data/lib/content_driven/version.rb

@@ -0,0 +1,3 @@
+module ContentDriven
+  VERSION = "0.1.0"
+end

data/lib/content_driven.rb

@@ -0,0 +1,9 @@
+require_relative "content_driven/blog"
+require_relative "content_driven/blog_post"
+require_relative "content_driven/tag"
+require_relative "content_driven/tag_cloud"
+require_relative "content_driven/site"
+require_relative "content_driven/version"
+
+module ContentDriven
+end

data/spec/dsl_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'content_driven'
+require 'content_driven/page'
+
+describe ContentDriven::Page do
+
+  it "will extend the DSL when subclassed" do
+    class ContentDriven::HamsterJam < ContentDriven::Page;end
+    expect(ContentDriven::Page.instance_methods.include? :get_hamster_jams).to be_true
+    expect(ContentDriven::Page.instance_methods.include? :add_hamster_jam).to be_true
+    expect(ContentDriven::Page.instance_methods.include? :get_hamster_jam).to be_true
+  end
+
+  it "will gain a method of the form add_x when subclassed" do
+    class ContentDriven::Pony < ContentDriven::Page;end
+    expect(ContentDriven::Page.instance_methods.include? :add_pony).to be_true
+    page = ContentDriven::Page.new
+    page.add_pony :wow_a_pony
+    expect(page.children.length).to eq(1)
+    expect(page.children[:wow_a_pony].class).to be(ContentDriven::Pony)
+  end
+
+  it "will gain a method of the form get_x when subclassed" do
+    class ContentDriven::Awesomeness < ContentDriven::Page;end
+    expect(ContentDriven::Page.instance_methods.include? :get_awesomeness).to be_true
+    page = ContentDriven::Page.new
+    awe = ContentDriven::Awesomeness.new
+    page.add_awesomeness :awe
+    awe = page.get_awesomeness :awe
+    expect(awe.class).to be(ContentDriven::Awesomeness)
+  end
+
+  it "will gain a method of the form add_x when subclassed" do
+    class ContentDriven::Cat < ContentDriven::Page; end
+    class ContentDriven::Dog < ContentDriven::Page; end
+    expect(ContentDriven::Page.instance_methods.include? :get_cats).to be_true
+    page = ContentDriven::Page.new do
+      add_cat :first
+      add_cat :second
+      add_dog :third
+      add_cat :fourth
+      add_dog :fifth
+    end
+    puts "Cats"
+    expect(page.children.length).to be(5)
+    expect(page.get_dogs.length).to be(2)
+    expect(page.get_cats.length).to be(3)
+  end
+
+end

data/spec/page_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'content_driven'
+require 'content_driven/page'
+
+describe ContentDriven::Page do
+
+  before :each do
+    @page =  ContentDriven::Page.new
+    @title = "Bum Cakes!"
+  end
+
+  it "can be initialized with a block" do
+    page = ContentDriven::Page.new {add_blog :test}
+    expect(page.children.length).to be(1)
+    expect(page.children[:test].class).to be(ContentDriven::Blog)
+  end
+
+  it "can be initialized with a nested block" do
+    page = ContentDriven::Page.new do
+      add_blog :test do
+        add_blog :test_2
+      end
+    end
+    expect(page.children.length).to be(1)
+    expect(page.children[:test].class).to be(ContentDriven::Blog)
+    expect(page.children[:test].children.length).to be(1)
+    expect(page.children[:test].children[:test_2].class).to be(ContentDriven::Blog)
+  end
+
+  it "has a title" do
+    @page.title = @title
+    expect(@page.title).to be(@title)
+  end
+
+  it "can add a child page with a key" do
+    child = ContentDriven::Page.new
+    @page.add_child :child, child
+    expect(@page.children.length).to be(1)
+    expect(@page.children[:child]).to be(child)
+    expect(child.parent).to be(@page)
+  end
+
+  it "can add a child page without a key" do
+    child = ContentDriven::Page.new
+    @page.add_child child
+    expect(@page.children.length).to be(1)
+    expect(@page.children.keys).to eq([:'1'])
+    expect(@page.children[:"1"]).to be(child)
+  end
+
+  it "can add a child page with a key and block" do
+    @page.add_child :child, ContentDriven::Page.new do
+      self.title = @title
+    end
+  end
+
+end

data/spec/routes_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'content_driven'
+require 'content_driven/page'
+require 'content_driven/site'
+require 'content_driven/blog'
+require 'content_driven/blog_post'
+
+describe ContentDriven::Page do
+  before :all do
+    @blog_title = blog_title = "The Many Uses of Toast"
+    @post_title = post_title = ["Decoration", "Recreation", "Procreation"]
+    @site = ContentDriven::Site.new do
+      add_blog :blog do
+        self.title = blog_title
+        add_blog_post :post_1 do
+          self.title = post_title.first
+        end
+        add_blog_post :post_2 do
+          self.title = post_title.last
+        end
+      end
+    end
+  end
+
+  context "/" do
+    it "can get the current page" do
+      expect(@site.content_for("/")).to be @site
+    end
+  end
+
+  context "child" do
+    before do
+      @blog = @site.content_for("blog")
+      @post = @blog.content_for("post_1")
+    end
+    it "can find by name" do
+      expect(@blog).to_not be_nil
+      expect(@blog.title).to be(@blog_title)
+    end
+    it "can find by name again" do
+      expect(@post.title).to be(@post_title.first)
+    end
+  end
+
+  context "descendent" do
+    before do
+      @post_1 = @site.content_for("/blog/post_1")
+      @post_2 = @site.content_for("/blog/post_2")
+    end
+    it "can find by name" do
+      expect(@post_1.title).to be(@post_title.first)
+      expect(@post_2.title).to be(@post_title.last)
+    end
+  end
+
+  context "404" do
+    it "will return nil" do
+      expect(@site.content_for("/fdsafds")).to be_nil
+      expect(@site.content_for("/blog/fdsafds")).to be_nil
+      expect(@site.content_for("/fdsafds/gfdsgfd")).to be_nil
+      expect(@site.content_for("/gfdsgfd/gfdsgfd/gfdsgfd")).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: content_driven
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A clean, simple DSL for defining websites, no database required
+email:
+- nicholas@forwardadvance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- content_driven.gemspec
+- lib/content_driven.rb
+- lib/content_driven/blog.rb
+- lib/content_driven/blog_post.rb
+- lib/content_driven/dsl.rb
+- lib/content_driven/page.rb
+- lib/content_driven/page_list.rb
+- lib/content_driven/routes.rb
+- lib/content_driven/site.rb
+- lib/content_driven/support.rb
+- lib/content_driven/tag.rb
+- lib/content_driven/tag_cloud.rb
+- lib/content_driven/version.rb
+- spec/dsl_spec.rb
+- spec/page_spec.rb
+- spec/routes_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/forwardadvance/content_driven
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Emphasised great Information Architecture, Metadata and SEO. Define your
+  website using the simple Ruby DSL. Build your pages in HAML, ERB, MD, etc. Deploy
+  via git.
+test_files:
+- spec/dsl_spec.rb
+- spec/page_spec.rb
+- spec/routes_spec.rb
+- spec/spec_helper.rb