silly 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2RiOTI2NmEyM2FlYmE2Y2U0NjhkOGYzZDAxZWQ1MzhiNjgxYjgxYQ==
+  data.tar.gz: !binary |-
+    NmU0ZmRlNzdjMWZmNTVhNjY5MWU1Y2QyOWM4MDhiNjQwZGVjM2IzYQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZGY0Y2I4MTI3NjVkNmU1OTdjNjM4ODkyNjFlZGRmMWFmMmNhOGNkYjUzMDYw
+    NjJjZTQ4MjU4ZDZiODgyNTc3YzI5MDdhMjM3MGIyYjYyYzg5MWQ1ODk1ZTVi
+    NzBiM2JkMjI3MDlkOWY0NDkwMGJmMjE1ODM2NWI2MGY4NjNlOTY=
+  data.tar.gz: !binary |-
+    ZWNkNDI4ZDM0NTAwMmMzMzA0OTg0NTBiYTFjNTFmYmRlNzRhMjhlZjhlOTlk
+    ZDRiMmIwYmIzMDYyNThkMDhjMTBhYzU3OTBmYzNhYzQ1ZDA1YTYwZGQyZTg5
+    NjM3MWMwM2IyMjYzYWQ5Zjg0NjE5OWM0MzZiODY0M2E3MGUyYjk=

data/Gemfile

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem 'cucumber'
-  gem 'capybara'
-  gem 'rspec'
+  gem 'cucumber', '~> 1'
+  gem 'capybara', '~> 2'
+  gem 'rspec', '~> 2'
 end

data/Rakefile

@@ -2,7 +2,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
 require 'rubygems'
 require 'rake'
 require 'bundler'
-require 'ruhoh/version'
+require 'silly/version'
 
 name = Dir['*.gemspec'].first.split('.').first
 gemspec_file = "#{name}.gemspec"

data/lib/silly.rb

@@ -7,6 +7,7 @@ require 'fileutils'
 require 'delegate'
 require 'observer'
 require 'set'
+require 'cgi'
 
 FileUtils.cd(path = File.join(File.dirname(__FILE__), 'silly')) do
   Dir[File.join('**', '*.rb')].each { |f| require File.join(path, f) }
@@ -14,7 +15,7 @@ end
 
 module Silly
   FileSeparator = File::ALT_SEPARATOR ?
-                    %r{#{ File::SEPARATOR }|#{ File::ALT_SEPARATOR }} :
+                    %r{#{ File::SEPARATOR }|#{ File::ALT_SEPARATOR.gsub('\\', '\\\\\\\\') }} :
                     File::SEPARATOR
 
   class Query
@@ -63,7 +64,7 @@ module Silly
 
     def execute
       @criteria["path"] ||= "*"
-      puts "EXECUTE:\n #{ @criteria.pretty_inspect }"
+      puts "EXECUTE:\n #{ @criteria.inspect }"
       data = files(@criteria["path"])
 
       unless @criteria["where"].empty?

data/lib/silly/base_model.rb

@@ -1,10 +1,11 @@
 module Silly
   class BaseModel < SimpleDelegator
-    def process
-      {
-        "data" => {},
-        "content" => File.open(realpath, 'r:UTF-8') { |f| f.read }
-      }
+    def data
+      {}
+    end
+
+    def content
+      File.open(realpath, 'r:UTF-8') { |f| f.read }
     end
   end
 end

data/lib/silly/data_model.rb

@@ -1,15 +1,16 @@
 module Silly
   class DataModel < SimpleDelegator
-    def process
+    def data
       data = {}
       cascade.each do |path|
         data = Silly::Utils.deep_merge(data, (Silly::Parse.data_file(path) || {}))
       end
 
-      { 
-        "data" => data,
-        "content" => Silly::Parse.page_file(realpath)
-      }
+      data
+    end
+
+    def content
+      Silly::Parse.page_file(realpath)
     end
   end
 end

data/lib/silly/item.rb

@@ -2,7 +2,7 @@ module Silly
   class Item
     include Observable
     attr_reader :pointer
-    attr_accessor :content, :collection
+    attr_accessor :data, :content, :collection
 
     def initialize(hash)
       @pointer = hash
@@ -48,12 +48,12 @@ module Silly
 
     # @returns[Hash Object] Top page metadata
     def data
-      @data ||= (_model.process["data"] || {})
+      @data ||= (_model.data || {})
     end
 
     # @returns[String] Raw page content
     def content
-      @content ||= (_model.process["content"] || "")
+      @content ||= (_model.content || "")
     end
 
     private

data/lib/silly/page_model.rb

@@ -3,41 +3,62 @@ module Silly
     DateMatcher = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
     Matcher = /^(.+\/)*(.*)(\.[^.]+)$/
 
-    # Process this file. See #parse_page_file
-    # @return[Hash] the processed data from the file.
-    #   ex:
-    #   { "content" => "..", "data" => { "key" => "value" } }
-    def process
+    class << self
+      attr_accessor :before_data, :after_data, :before_content, :after_content
+    end
+
+    def data
       return {} unless file?
 
-      parsed_page = Silly::Parse.page_file(realpath)
-      data = parsed_page['data']
+      data = Silly::Parse.page_file(realpath)["data"]
+      data['id'] = id
+
+      if self.class.before_data.respond_to?(:call)
+        data = self.class.before_data.call(data)
+      end
 
       filename_data = parse_page_filename(id)
+      data['title'] ||= filename_data['title']
+      data['date'] = parse_date(data['date'] || filename_data['date'])
+      data['_url'] = make_url(data)
 
-      data['pointer'] = pointer.dup
-      data['id'] = id
+      self.class.after_data.respond_to?(:call) ?
+        self.class.after_data.call(data) :
+        data
+    end
 
-      data['title'] = data['title'] || filename_data['title']
-      data['date'] ||= filename_data['date']
-
-      # Parse and store date as an object
-      begin
-        data['date'] = Time.parse(data['date']) unless data['date'].nil? || data['date'].is_a?(Time)
-      rescue
-        raise(
-          "ArgumentError: The date '#{data['date']}' specified in '#{ id }' is unparsable."
-        )
-        data['date'] = nil
-      end
+    def content
+      result = Silly::Parse.page_file(realpath)["content"]
 
-      parsed_page['data'] = data
+      if self.class.before_content.respond_to?(:call)
+        result = self.class.before_content.call(result)
+      end
 
-      parsed_page
+      self.class.before_content.respond_to?(:call) ?
+        self.class.before_content.call(result) :
+        result
     end
 
     private
 
+    def make_url(data)
+      page_data = data.dup
+      format = page_data['permalink'] || "/:path/:filename"
+      slug = Silly::UrlSlug.new(item: self, data: page_data, format: format)
+      slug.generate
+    end
+
+    # Parse and store date as an object
+    def parse_date(date)
+      return date if (date.nil? || date.is_a?(Time))
+
+      Time.parse(date)
+    rescue
+      raise(
+        "ArgumentError: The date '#{ date }' specified in '#{ id }' is unparsable."
+      )
+    end
+
     # Is the item backed by a physical file in the filesystem?
     # @return[Boolean]
     def file?

data/lib/silly/string_format.rb

@@ -0,0 +1,51 @@
+module Silly
+  # StringFormat is meant to expose the common (public) interface
+  # for where strings (namely URLS) are formatted.
+  # Users are encouraged to reimplement these methods via plugins to enable
+  # custom-defined slug generation logic based on their tastes. 
+  #
+  # TODO: 
+  #   - Natively support the most popular slug formats.
+  #   - Better support for Internationalization.
+  module StringFormat
+
+    # Public interface for building 'clean slugs'
+    # Redefine this method to implement custom slug generation.
+    def self.clean_slug(string)
+      hyphenate(string)
+    end
+
+    def self.clean_slug_and_escape(string)
+      CGI::escape(clean_slug(string))
+    end
+
+    # Simple url slug normalization.
+    # Converts all non word characters into hyphens.
+    # This may not be what you want so feel free to overwite the public
+    # method in place of another formatter.
+    #
+    # Ex: My Post Title ===> my-post-title
+    def self.hyphenate(string)
+      string = string.to_s.downcase.strip.gsub(/[^\p{Word}+]/u, '-')
+      string.gsub(/^\-+/, '').gsub(/\-+$/, '').gsub(/\-+/, '-')
+    end
+
+    # TODO: Probably use ActiveSupport for this stuff
+    # Ex: my-post-title ===> My Post Title
+    def self.titleize(string)
+      string.gsub(/[^\p{Word}+]/u, ' ').gsub(/\b\w/){ $&.upcase }
+    end
+
+    # Convert CamelCase to snake_case
+    # Thanks ActiveSupport: http://stackoverflow.com/a/1509939/101940
+    def self.snake_case(string)
+      string.
+      to_s.
+      gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end

data/lib/silly/url_slug.rb

@@ -0,0 +1,157 @@
+module Silly
+  class UrlSlug
+    @convertable_extensions = %w{ .md .markdown .mustache .haml .erb }
+    class << self
+      attr_reader :convertable_extensions
+
+      def add_extensions(ext)
+        if ext.is_a?(Array)
+          @convertable_extensions += ext
+        else
+          @convertable_extensions << ext
+        end
+      end
+    end
+
+    def initialize(opts)
+      @item = opts[:item]
+      @scope =  @item.id.split('/').first
+      @data = opts[:data]
+      @format = opts[:format]
+
+      parts = @item.id.split('/')
+      parts.shift
+      @scoped_id = parts.join('/')
+    end
+
+    # @return[String] URL Slug based on the given data and format.
+    # The url should always have a preceeding slash "/some-url"
+    def generate
+      url = @format.include?(':') ? dynamic : literal
+      url = process_url_extension(url)
+
+      url.to_s.start_with?('/') ? url : "/#{ url }"
+    end 
+
+    # @return[String] the literal URL without token substitution.
+    def literal
+      @format.gsub(/^\//, '').split('/').map {|p| CGI::escape(p) }.join('/')
+    end
+
+    # @return[String] the dynamic URL with token substitution.
+    def dynamic
+      cache = data
+      result = @format
+                .gsub(/:[^\/\.]+/) { |a| cache[$&.gsub(':', '')] }
+                .gsub('//', '/')
+                .split('/')
+
+      # this is ugly but I'm out of ideas. Help!
+      last = result.pop
+      if uses_extension?
+        last = last
+                .split('.')
+                .map{ |a| Silly::StringFormat.clean_slug_and_escape(a) }
+                .join('.')
+      else
+        last = Silly::StringFormat.clean_slug_and_escape(last)
+      end
+
+      result
+        .map{ |a| Silly::StringFormat.clean_slug_and_escape(a) }
+        .join('/') +
+        "/#{ last }"
+    end
+
+    def data
+      result = @data
+      result = result.merge(date_data) if uses_date?
+
+      result.merge({
+        "filename"          => filename,
+        "path"              => path,
+        "relative_path"     => relative_path,
+        "categories"        => category,
+      })
+    end
+
+    def date_data
+      date = Time.parse(@data['date'].to_s)
+
+      {
+        "year"       => date.strftime("%Y"),
+        "month"      => date.strftime("%m"),
+        "day"        => date.strftime("%d"),
+        "i_day"      => date.strftime("%d").to_i.to_s,
+        "i_month"    => date.strftime("%m").to_i.to_s,
+      }
+    rescue ArgumentError, TypeError
+      raise(
+        "ArgumentError:" +
+        " The file '#{ @item.realpath }' has a permalink '#{ @format }'" +
+        " which is date dependant but the date '#{ @data['date'] }' could not be parsed." +
+        " Ensure the date's format is: 'YYYY-MM-DD'"
+      )
+    end
+
+    def filename
+      File.basename(@scoped_id, ext)
+    end
+
+    def ext
+      @item.ext
+    end
+
+    # Category is only the first one if multiple categories exist.
+    def category
+      string = Array(@data['categories'])[0]
+      return '' if string.to_s.empty?
+
+      string.split('/').map { |c|
+        Silly::StringFormat.clean_slug_and_escape(c)
+      }.join('/')
+    end
+
+    def relative_path
+      string = File.dirname(@scoped_id)
+      (string == ".") ? "" : string
+    end
+
+    def path
+      File.join(@scope, relative_path)
+    end
+
+    private
+
+    def uses_date?
+      result = false
+      %w{ :year :month :day :i_day :i_month }.each do |token|
+        if @format.include?(token)
+          result = true
+          break
+        end
+      end
+
+      result
+    end
+
+    # Is an extension explicitly defined?
+    def uses_extension?
+      @format =~ /\.[^\.]+$/
+    end
+
+    # The url extension depends on multiple factors: 
+    # user-config   : preserve any extension set by the user in the format.
+    # converters    : Automatically change convertable extensions to .html
+    #                 Non-convertable file-extensions should 'pass-through' 
+    #
+    # @return[String]
+    def process_url_extension(url)
+      return url if uses_extension?
+
+      url += self.class.convertable_extensions.include?(ext) ? '.html' : ext
+
+      url.gsub(/index|index.html$/, '').gsub(/\.html$/, '')
+    end
+  end
+end

data/lib/silly/version.rb

@@ -1,3 +1,3 @@
 module Silly
-  Version = VERSION = '0.0.1'
+  Version = VERSION = '0.0.2'
 end

data/silly.gemspec

@@ -13,9 +13,9 @@ Gem::Specification.new do |s|
   s.description       = 'Silly is an ODM for parsing and querying a directory like you would a database -- useful for static websites.'
 
 
-  s.add_development_dependency 'cucumber'
-  s.add_development_dependency 'capybara'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'cucumber', '~> 1'
+  s.add_development_dependency 'capybara', '~> 2'
+  s.add_development_dependency 'rspec', '~> 2'
 
   s.files = `git ls-files`.
               split("\n").

metadata

@@ -1,64 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: silly
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Jade Dominguez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-30 00:00:00.000000000 Z
+date: 2014-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 description: Silly is an ODM for parsing and querying a directory like you would a
   database -- useful for static websites.
 email: plusjade@gmail.com
@@ -86,32 +79,33 @@ files:
 - lib/silly/page_model.rb
 - lib/silly/parse.rb
 - lib/silly/query_operators.rb
+- lib/silly/string_format.rb
+- lib/silly/url_slug.rb
 - lib/silly/utils.rb
 - lib/silly/version.rb
 - silly.gemspec
 homepage: http://github.com/ruhoh/silly
 licenses:
 - http://www.opensource.org/licenses/MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Silly is a filesystem based Object Document Mapper.
 test_files: []