RubyGems - staticpress - Versions diffs - 0.3.0 → 0.4.0 - Mend

staticpress 0.3.0 → 0.4.0

Files changed (94) hide show

data.tar.gz.sig CHANGED Viewed

Binary file

data/docs/Gemfile ADDED Viewed

@@ -0,0 +1,8 @@
+source :rubygems
+gem 'staticpress', :path => '..'
+gem 'compass'
+gem 'haml'
+gem 'rdiscount'
+gem 'sass'

data/{tests/sample_sites/test_blog → docs}/README.markdown RENAMED Viewed

File without changes

data/{tests/sample_sites/test_blog → docs}/config.ru RENAMED Viewed

File without changes

data/docs/config.yml ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ ---
2	+ :title: Staticpress Documentation

data/docs/content/docs/diving-deeper.markdown ADDED Viewed

	@@ -0,0 +1,3 @@
1	+ # Diving Deeper
2	+
3	+

data/docs/content/docs/setup.markdown ADDED Viewed

@@ -0,0 +1,15 @@
+# Zero To Blogging
+## Pre-requisites
+Staticpress is written in Ruby, so the first thing you will need is a Ruby interpreter. Chances are you have one on your system already, but if not the [official site can get you setup](http://www.ruby-lang.org/en/). Ruby comes with a package manager called RubyGem (gem) that makes installing Ruby libraries (known as gems) super easy.
+Once you have Ruby, open a terminal and type `gem install staticpress`. This command installs Staticpress so you can use it. Staticpress is a command line application, so leave your terminal open. If you ever get stuck and need a quick tip, run `staticpress help [task]`.
+## Usage
+When you want to create a new Staticpress blog, simply run `staticpress new <path-to-blog> [name-of-blog]`. Staticpress will create the `<path-to-blog>` for you if it does not exist. `[name-of-blog]` is optional. If you leave it out, Staticpress will make up a blog name from `<path-to-blog>`. Either way, `cd` into `<path-to-blog>`; this will be the place you need to be for all the other commands to work. By the way Staticpress uses several conventions to keep things simple. For instance many commands you are asked to type on the terminal take parameters. Required parameters will `<look-like-this>`, while optional parameters will `[look-like-this]`.
+## Hello, World
+After creating a new blog, you will probably want to create a new post. Type `staticpress create <title>` to create a new post. Staticpress will create a new empty post in `content/_posts/`. Open this file with your favorite text editor and start pontificating. When your are done, type `staticpress serve` to turn on the local development server. Open your favorite browser and navigate to [http://localhost:4000/](http://localhost:4000) to preview your post. Congratulations!

data/docs/content/index.markdown ADDED Viewed

	@@ -0,0 +1 @@
1	+ hello

data/features/happy_path.feature CHANGED Viewed

@@ -9,6 +9,10 @@ Feature: The happy path
     Then the exit status should be 0
     And the output should contain "Usage"
+    Given I run `staticpress -h`
+    Then the exit status should be 0
+    And the output should contain "Usage"
     Given I run `staticpress --help`
     Then the exit status should be 0
     And the output should contain "Usage"
@@ -17,6 +21,10 @@ Feature: The happy path
     Then the exit status should be 0
     And the output should contain "Staticpress"
+    Given I run `staticpress -v`
+    Then the exit status should be 0
+    And the output should contain "Staticpress"
     Given I run `staticpress --version`
     Then the exit status should be 0
     And the output should contain "Staticpress"
@@ -71,7 +79,7 @@ Feature: The happy path
   Scenario: Listing all routes
     Given a blog with content exists
-    When I run `staticpress list route`
+    When I run `staticpress list url_path`
     Then the output should contain "/"
     And the output should contain "/about"
     And the output should contain "/hello-goodbye"
@@ -85,6 +93,33 @@ Feature: The happy path
       | public/index.html       |
       | public/about/index.html |
+  Scenario: Building a site a custom homepage
+    Given a blog with content exists
+    And I write to "content/index.markdown" with:
+      """
+      ---
+      title: Custom Home Page
+      ---
+      in custom page
+      """
+    When I run `staticpress build`
+    Then the file "public/index.html" should contain exactly:
+      """
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <title>Custom Home Page | Transient Thoughts</title>
+          <link href='/assets/basic/styles/all.css' rel='stylesheet' type='text/css' />
+          <script src='http://ajax.googleapis.com/ajax/libs/jquery/1.7.0/jquery.min.js'></script>
+          <script src='/assets/basic/scripts/application.js'></script>
+        </head>
+        <body>
+          <p>in custom page</p>
+        </body>
+      </html>
+      """
   Scenario: Pushing a compiled site to a remote location
     Given a blog with content exists
     And the blog has been previously built

data/features/step_definitions/staticpress_steps.rb CHANGED Viewed

@@ -7,7 +7,7 @@ Given /^a blog exists$/ do
 end
 Given /^a blog with content exists$/ do
-  step("a blog exists")
+  step('a blog exists')
   Staticpress::CLI.new.create_page('about')
   Staticpress::CLI.new.create('hello-goodbye')
 end

data/lib/skeleton/Gemfile CHANGED Viewed

@@ -5,6 +5,4 @@ gem 'staticpress'
 gem 'compass'
 gem 'haml'
 gem 'rdiscount'
-gem 'rubypants'
-gem 'RedCloth'
 gem 'sass'

data/lib/staticpress/booter.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('./Gemfile')
-if File.exists?(ENV['BUNDLE_GEMFILE']) && !defined? Bundler
+if File.exists?(ENV['BUNDLE_GEMFILE'])
   require 'bundler'
   Bundler.require

data/lib/staticpress/cli.rb CHANGED Viewed

@@ -20,8 +20,8 @@ module Staticpress
     default_task :help
-    map '--help' => :help
-    map '--version' => :version
+    map ['-h', '--help'] => :help
+    map ['-v', '--version'] => :version
     desc 'help [task]', 'Describe available tasks or one specific task'
     def help(*args)

data/lib/staticpress/content/base.rb CHANGED Viewed

@@ -5,6 +5,7 @@ require 'yaml'
 require 'staticpress'
 require 'staticpress/metadata'
+require 'staticpress/route'
 require 'staticpress/theme'
 require 'staticpress/view_helpers'
@@ -13,15 +14,25 @@ module Staticpress::Content
     extend Staticpress::Helpers
     include Staticpress::Helpers
-    attr_reader :route, :template_path
+    attr_reader :params
-    def initialize(route, template_path)
-      @route = route
-      @template_path = template_path
+    def initialize(params)
+      clean_params = params.select { |key, value| value }.map do |key, value|
+        cast_value = case Staticpress::Route::REGEX_STUBS[key].klass
+          when :integer then Integer value rescue value
+          when :symbol  then value.to_sym
+          else               value
+        end
+        [ key, cast_value ]
+      end
+      @params = optional_param_defaults.merge Hash[clean_params]
     end
     def ==(other)
-      other.respond_to?(:route) && (route == other.route)
+      other.respond_to?(:params) && (params == other.params) &&
+      other.respond_to?(:url_path) && (url_path == other.url_path)
     end
     def content
@@ -43,12 +54,12 @@ module Staticpress::Content
       template_path.file?
     end
-    def inspect
-      parts = [ "url_path=#{route.url_path}" ]
-      "#<#{self.class} #{parts.join ', '}>"
+    def full_title
+      [
+        title,
+        config.title
+      ].join config.title_separators.site
     end
-    alias to_s inspect
     def layout
       if meta.layout || config.markup_templates.include?(template_path.extname[1..-1])
@@ -61,8 +72,12 @@ module Staticpress::Content
       Staticpress::Metadata.new(content.names.include?('frontmatter') ? YAML.load(content[:frontmatter]) : {})
     end
+    def optional_param_defaults
+      {}
+    end
     def output_path
-      base = Staticpress.blog_path + config.destination_path + route.url_path.sub(/^\//, '')
+      base = Staticpress.blog_path + config.destination_path + url_path.sub(/^\//, '')
       (config.index_file && config.markup_templates.include?(template_path.extname[1..-1])) ? base + config.index_file : base
     end
@@ -86,8 +101,10 @@ module Staticpress::Content
     end
     def save
-      FileUtils.mkdir_p output_path.dirname
-      output_path.open('w') { |f| f.write render }
+      unless output_path.file?
+        FileUtils.mkdir_p output_path.dirname
+        output_path.open('w') { |f| f.write render }
+      end
     end
     def template_context
@@ -110,23 +127,49 @@ module Staticpress::Content
       self.class.theme
     end
-    def full_title
-      [
-        title,
-        config.title
-      ].join config.title_separators.site
-    end
     def title
       if meta.title
         meta.title
       else
-        titleize(route.url_path)
+        titleize(url_path)
+      end
+    end
+    def to_s
+      "#<#{self.class} url_path=#{url_path}, params=#{Hash[params.sort]}>"
+    end
+    def url_path
+      # grab url pattern for content type
+      pattern = config.routes[self.class.type].clone
+      # regex to find optional segment in pattern
+      # NOTE cannot find more than one optional segment per pattern
+      optional_segment_finder = /\((?<optional_segment>.+)\)\?/
+      # replace optional segment in pattern with result of block
+      # optional segments should have one keys
+      pattern.gsub! optional_segment_finder do |optional_segment|
+        # http://www.rubular.com/r/LiOup53CI1
+        # http://www.rubular.com/r/TE7E9ZdtKF
+        # grab the key from optional segment
+        optional_key = /:(?<optional_key>[0-9a-z_]+)/.match(optional_segment)[:optional_key].to_sym
+        # if params has the optional key and params optional key is not the key's default, remove optional segment indicators
+        # otherwise return nil to remove optional segment entirely
+        optional_segment_finder.match(optional_segment)[:optional_segment] if params[optional_key] && (params[optional_key] != optional_param_defaults[optional_key])
+      end
+      # actually do conversion from pattern to url path
+      Staticpress::Route::REGEX_STUBS.keys.inject(pattern) do |p, key|
+        p.gsub /:#{key}/, params[key].to_s
       end
     end
-    def self.supported_extensions
-      Tilt.mappings.keys.map &:to_sym
+    def self.find_by_url_path(url_path)
+      params = Staticpress::Route.extract_params config.routes[type], url_path
+      new params if params
     end
     def self.theme

data/lib/staticpress/content/category.rb CHANGED Viewed

@@ -1,19 +1,28 @@
 require 'staticpress'
 require 'staticpress/content/base'
 require 'staticpress/content/collection_content'
-require 'staticpress/route'
+require 'staticpress/content/resource_content'
 module Staticpress::Content
   class Category < Base
     extend CollectionContent
+    extend ResourceContent
+    def optional_param_defaults
+      { :number => 1 }
+    end
     def sub_content
-      paginate(self.class.content_by_category[route.params[:name]].sort)[(Integer route.params[:number]) - 1]
+      paginate(self.class.content_by_category[params[:name]].sort)[params[:number] - 1]
+    end
+    def template_path
+      self.class.template_path
     end
     def self.all
       categories.map do |category|
-        find_by_route Staticpress::Route.new(:content_type => self, :name => category, :number => '1')
+        new :name => category, :number => '1'
       end
     end

data/lib/staticpress/content/collection_content.rb CHANGED Viewed

@@ -2,10 +2,6 @@ require 'staticpress'
 module Staticpress::Content
   module CollectionContent
-    def find_by_route(route)
-      new(route, template_path)
-    end
     def template_path
       theme.view_for(type) || theme.view_for(:default)
     end

data/lib/staticpress/content/index.rb CHANGED Viewed

@@ -1,19 +1,26 @@
 require 'staticpress'
 require 'staticpress/content/base'
 require 'staticpress/content/collection_content'
-require 'staticpress/route'
 module Staticpress::Content
   class Index < Base
     extend CollectionContent
+    def optional_param_defaults
+      { :number => 1 }
+    end
     def sub_content
-      paginate(Staticpress::Content::Post.all)[(Integer route.params[:number]) - 1]
+      paginate(Staticpress::Content::Post.all)[params[:number] - 1]
+    end
+    def template_path
+      self.class.template_path
     end
     def self.all
       [
-        (find_by_route Staticpress::Route.new(:content_type => self, :number => '1'))
+        new(:number => '1')
       ]
     end
   end

data/lib/staticpress/content/page.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+require 'pathname'
 require 'staticpress'
 require 'staticpress/content/base'
 require 'staticpress/content/resource_content'
@@ -7,11 +9,36 @@ require 'staticpress/route'
 module Staticpress::Content
   class Page < Base
     include StaticContent
+    include ResourceContent
     extend ResourceContent
     extend StaticContent
+    attr_reader :extension, :full_slug
+    def initialize(params)
+      super
+      index = extensionless_basename Pathname.new(config.index_file)
+      @full_slug = params[:slug]
+      @extension = find_supported_extension(Staticpress.blog_path + config.source_path + full_slug)
+      if @extension.nil? && !template_path.file?
+        @full_slug = [
+          params[:slug],
+          index
+        ].reject(&:empty?).join('/')
+        @extension = find_supported_extension(Staticpress.blog_path + config.source_path + full_slug)
+      end
+    end
     def static?
-      (Staticpress.blog_path + config.source_path + route.params[:slug]).file?
+      (Staticpress.blog_path + config.source_path + params[:slug]).file?
+    end
+    def template_path
+      slug = extension ? "#{full_slug}.#{extension}" : full_slug
+      Staticpress.blog_path + config.source_path + slug
     end
     def self.all
@@ -36,25 +63,13 @@ module Staticpress::Content
     def self.find_by_path(path)
       if path.file?
-        params = {
-          :content_type => self,
-          :slug => parse_slug(path, (Staticpress.blog_path + config.source_path))
-        }
-        find_by_route Staticpress::Route.new(params)
+        raw_slug = parse_slug(path, (Staticpress.blog_path + config.source_path)).first
+        basename = extensionless_basename Pathname.new(config.index_file)
+        slug = raw_slug.sub(/.*(\/?#{basename})$/, '')
+        new :slug => slug
       end
     end
-    def self.find_by_route(route)
-      return nil unless route
-      base = Staticpress.blog_path + config.source_path
-      path = base + route.params[:slug]
-      return new(route, path) if path.file?
-      load_resource route, base, route.params[:slug]
-    end
     def self.template
       <<-TEMPLATE
 in page

data/lib/staticpress/content/post.rb CHANGED Viewed

@@ -5,8 +5,16 @@ require 'staticpress/route'
 module Staticpress::Content
   class Post < Base
+    include ResourceContent
     extend ResourceContent
+    attr_reader :extension
+    def initialize(params)
+      super
+      @extension = find_supported_extension template_path
+    end
     def <=>(other)
       other.respond_to?(:created_at) ? (created_at <=> other.created_at) : super
     end
@@ -16,15 +24,24 @@ module Staticpress::Content
     end
     def created_on
-      date = route.params
-      Time.utc date[:year], date[:month], date[:day]
+      Time.utc params[:year], params[:month], params[:day]
+    end
+    def template_path
+      name = [
+        params[:year],
+        params[:month],
+        params[:day],
+        (extension ? "#{params[:title]}.#{extension}" : params[:title])
+      ].join('-')
+      Staticpress.blog_path + config.posts_source_path + name
     end
     def title
       if meta.title
         meta.title
       else
-        titleize(route.params[:title])
+        titleize(params[:title])
       end
     end
@@ -51,36 +68,14 @@ module Staticpress::Content
     def self.find_by_path(path)
       if path.file?
         stubs = Staticpress::Route::REGEX_STUBS
-        regex = /#{stubs[:year].regex}-#{stubs[:month].regex}-#{stubs[:day].regex}-#{stubs[:title].regex}/
+        regex = /#{stubs[:year].regex}-#{stubs[:month].regex}-#{stubs[:day].regex}-#{stubs[:title].regex}\.(.+)/
         if filename_parts = path.basename.to_s.match(regex)
-          params = {
-            :content_type => self,
-            :year => filename_parts[:year],
-            :month => filename_parts[:month],
-            :day => filename_parts[:day],
-            :title => filename_parts[:title]
-          }
-          find_by_route Staticpress::Route.new(params)
+          new hash_from_match_data(filename_parts)
         end
       end
     end
-    def self.find_by_route(route)
-      return nil unless route
-      base = Staticpress.blog_path + config.posts_source_path
-      parts = route.params
-      stub = [
-        parts[:year],
-        parts[:month],
-        parts[:day],
-        parts[:title]
-      ].join '-'
-      load_resource route, base, stub
-    end
     def self.template
       now = Time.now.utc