nanoc-oo 0.0.1

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 @@
+--color --format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,31 @@
+# NanocOO
+
+TODO: Write a gem description 
+TODO: Write a gem description 
+TODO: Write a gem description 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nanoc-oo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nanoc-oo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/nanoc-oo

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require 'nanoc-oo'
+require 'thor/group'
+
+class CLI < Thor::Group
+  argument :name, type: :string, desc: 'directory name for new site'
+  class_option :blank, type: :boolean, default: false, desc: 'without content files'
+  desc 'creates nanoc site with object-oriented wrapper'
+
+  def create_it
+    NanocOO.create_site name, options[:blank]
+  end  
+
+  def self.banner; super.sub('cli ','') end
+end
+
+ARGV.empty?? CLI.usage : CLI.start

data/cucumber.yml

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/data/nanoc-oo/wrapper/Rules

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+
+
+###############
+#     Odd     #
+###############
+
+class Nanoc::Item
+  def +@
+    self[:object]
+  end   
+end
+
+#compile('/'){ layout 'default' };  route('/'){'/index.html'}
+#compile('/stylesheet/'){};         route('/stylesheet/'){'/style.css'}
+
+@file = '../log.txt'
+def log?
+  File.exist?(@file) ? File.read(@file) : ''
+end
+def log data
+  File.write @file, log? + "\n#{ data }"
+end
+
+module Preprocessor  # one .preprocess per item!
+
+  def self.preprocess! context, classes
+
+    while item = context.items.find { |item| !(+item) || !(+item).processed? }
+      prepare item, classes
+      (+item).do_preprocess context
+    end
+
+    fix_children context # after preprocessing finished
+  end
+
+  def self.prepare item, classes
+    item[:object] = classes[item].new(item) unless +item
+    item
+  end
+  def self.fix_children context
+    context.items.each do |item|
+      (+item).fix_children context
+    end
+  end  
+end
+
+module ::Builder
+
+  def self.build! item, context, items_context
+    
+    unless item.is_a? FakeDir
+
+      context.compile (+item).identifier do
+        (+item).compile self
+      end
+
+      context.route (+item).identifier do
+        (+item).route    
+      end
+    end
+
+    (+item).compile_children context, items_context
+  end
+end
+
+def root items, classes
+  items.find { |item| item.identifier == '/' } or Preprocessor.prepare Nanoc::Item.new('', { hidden: true }, '/'), classes
+end
+
+
+#################
+#    Layouts    #
+#################
+#
+# The first matching rule is used:
+# layout '*', :erb
+# layout '/default/', :slim
+# layout '/default/', :haml, format: :html5
+# layout %r{^/_.+/$}, :erb
+# /default/ may be layouts/default.with-any-extension
+# all unmatched layouts will be compiled using filter determined by extension:
+#
+
+FakeItems.new('layouts').items.each do |item|
+  layout item.identifier, FilterFor[item.file]
+end
+
+
+#################
+#     Items     #
+#################
+
+fake = FakeItems.new('content')
+classes = ItemClass.new
+
+
+##################
+#   Preprocess   #
+##################
+
+Preprocessor.preprocess! fake, classes
+
+preprocess do
+  Preprocessor.preprocess! self, classes
+end
+
+
+###################
+#  Compile/Route  #
+###################
+#
+# FIXME "if" just for specs, to prevent crashes
+#
+Builder.build! root(fake.items, classes), self, fake if fake.items.count > 0

data/data/nanoc-oo/wrapper/lib/classes/1_page.rb

@@ -0,0 +1,198 @@
+def is_binary_file? file
+  require 'ptools'
+  File.binary? file
+end
+
+# module Hidable
+#   def route *a
+#     return nil if hidden?
+#     super
+#   end
+
+#   # def compile *a
+#   #   return nil if hidden?
+#   #   super
+#   # end
+
+#   private
+#   def hidden?
+#   #  item[:hidden] == true
+#   end
+# end
+
+module PageDefaults
+  def route
+    return nil if self.class::ROUTE == false
+    self.class::ROUTE or identifier.chop + (html?? '/index.html' : ".#{extension}")
+  end
+
+  #def item_path
+  #  identifier[%r|(/.*/).*?/|]
+  #end
+  #def item_name
+  #  identifier[%r|/.*(/.*?/)|]
+  #end
+
+  def compile_children context, items_context
+    children(items_context).each do |child|
+      ::Builder.build! child, context, items_context
+    end
+  end
+
+  def children context=nil
+    return @fixed_children if @fixed_children
+    raise 'context is needed to get children before preprocessing is finished!' unless context
+    direct_children context
+  end
+
+
+  def fix_children context
+    @fixed_children = children context
+  end
+
+  
+  def direct_children context
+    context.items.select { |items| items.identifier =~ %r|^#{ Regexp.escape identifier }[^/]+/$| }
+  end
+  
+  def compile context
+    apply_filter context
+    apply_layout context
+    after_compile context
+  end
+
+  def apply_filter context
+    context.filter filter if filter
+  end
+  def filter
+    return self.class::FILTER if self.class::FILTER
+    return @@filters[last_extension] if @@filters[last_extension]
+  end
+  def apply_layout context
+    context.layout layout if layout
+  end
+  def layout
+    self.class::LAYOUT if defined? self.class::LAYOUT
+  end
+  def after_compile context
+    context.filter :relativize_paths, type: kind if kind  
+  end
+
+  def kind
+    case
+    when html? then :html
+    when css? then :css
+    end
+  end
+  
+  
+  def css?
+    really_css?
+  end
+  
+  def really_css?
+    extension.split('.').find { |ext| ext =~ /^(#{ CSS_EXTENSIONS })$/ } ? true : false
+  end    
+
+
+  
+  # uses FakeItem#file or NanocItem#[:binary]
+  #
+  def binary?
+    item.respond_to?(:file) ? is_binary_file?(item.file) : item[:binary]
+  end
+  
+  def html?
+    really_html?
+  end
+  
+  def really_html?
+    extension.split('.').find { |ext| ext =~ /^(#{ HTML_EXTENSIONS })$/ } ? true : false
+  end  
+  
+  def extension
+    self.class::EXT or item[:extension] or ''
+  end
+  
+  def last_extension
+    extension[/[.](.+?)$/, 1] or extension
+  end
+  
+  FILTER = nil
+  ROUTE = nil
+  EXT = nil
+  CSS_EXTENSIONS = 'css|sass|scss'
+  HTML_EXTENSIONS = 'html|htm|slim|haml|md'
+  PRIORITY = 0
+  @@filters = {'md' => :kramdown, 'slim' => :slim, 'erb' => :erb}
+end
+
+class Page
+  include PageDefaults
+  # include Hidable
+  attr_reader :item
+
+  def initialize item
+    @item = item
+  end
+
+  def self.create context, *params
+    context.items << item = Nanoc::Item.new(*params)
+    item[:object] = self.new item
+  end
+  
+  def preprocess context
+  end
+
+  def do_preprocess context
+    preprocess context
+  ensure
+    @processed = true
+  end
+
+  def processed?
+    @processed
+  end
+
+  def identifier
+    item.identifier
+  end
+  def identifier= value
+    item.identifier = value
+  end
+  
+  def self.accept? identifier
+    return false unless mask = good_id
+    identifier =~ mask ? true : false  
+  end
+
+  def self.good_id
+    id = self::GOOD_ID
+    case id
+    when String
+      id.gsub!('**','.+')   # any level
+      id.gsub!('*','[^/]+') # one level
+      id = "/#{id}" unless id[0] == '/'
+      id = "#{id}/" unless id[-1] == '/'
+      /^#{id}$/
+    else
+      id
+    end
+  end
+  
+  def representation
+    rep
+  end
+  def rep
+    :default
+  end
+end
+
+class UndefinedPage < Page
+  PRIORITY = fixnum_min = -(2**(0.size * 8 -2))
+  def self.accept? *a; true end
+
+  def route *a; end
+  def compile *a; end
+  def preprocess *a; end
+end

data/data/nanoc-oo/wrapper/lib/fake_dir.rb

@@ -0,0 +1,27 @@
+class FakeDir
+  attr_reader :file
+  attr_accessor :identifier  
+
+  def initialize file
+    @file = file
+    @values = {}  
+    @identifier = get_identifier      
+  end    
+
+  def +@
+    @values[:object]
+  end 
+  def []= key, value
+    @values[key] = value
+  end
+  def [] key
+    @values[key]
+  end 
+
+  private
+  def get_identifier
+    dir = @file.sub(/.+?\//, '/')
+    dir << '/' if dir[-1] != '/'
+    dir
+  end     
+end

data/data/nanoc-oo/wrapper/lib/fake_item.rb

@@ -0,0 +1,39 @@
+class FakeItem
+  attr_reader :file
+  attr_accessor :identifier
+    
+  def initialize file
+    @file = file
+    @identifier = get_identifier
+    @values = {}
+  end
+
+  def binary?
+    require 'ptools'
+    File.binary?(file)
+  end
+
+  def raw_content
+    File.read file
+  end
+  
+  def +@
+    @values[:object]
+  end 
+  def []= key, value
+    @values[key] = value
+  end
+  def [] key
+    return extension if key == :extension
+    @values[key]
+  end  
+    
+  private
+  def get_identifier
+    (@file.sub(/.+?\//, '/').sub(/\.[^\/]+/, '') + '/').sub(%r[/index/$], '/')
+  end
+  
+  def extension
+    @file[/\.([^\/]+)$/, 1].to_s
+  end  
+end

data/data/nanoc-oo/wrapper/lib/fake_items.rb

@@ -0,0 +1,22 @@
+class FakeItems
+  attr_reader :items
+  
+  def initialize where, params={nanoc:false}
+    @params = params
+    all = Dir["#{where}/**/*"]
+    files = all.reject { |those| File.directory? those }.map { |item| create item }  # FakeItem.new item }
+    dirs  = all.select { |those| File.directory? those }.map { |item| FakeDir.new item  }
+    dirs.reject! { |dir| files.find { |file| file.identifier == dir.identifier } }
+    @items = files + dirs
+  end
+
+  def create item
+    fake = FakeItem.new item
+    if @params[:nanoc] && defined? Nanoc
+      content = fake.binary?? fake.file : File.read(fake.file)
+      Nanoc::Item.new content, {}, fake.identifier
+    else
+      fake
+    end
+  end
+end

data/data/nanoc-oo/wrapper/lib/filter_for.rb

@@ -0,0 +1,14 @@
+module FilterFor
+  extend self
+  KNOWN_FILTERS = { 'html' => :erb, 'htm' => :erb }
+  
+  def [] file
+    filter_ext File.extname file
+  end
+  
+  private
+  def filter_ext ext
+    ext = ext.sub(/^\./,'')
+    KNOWN_FILTERS[ext] or ext.to_sym
+  end
+end

data/data/nanoc-oo/wrapper/lib/item_class.rb

@@ -0,0 +1,22 @@
+class Class
+  def subclasses
+    ObjectSpace.each_object(Class).select { |klass| klass < self }
+  end
+end
+
+class ItemClass
+  attr_reader :classes
+  
+  def initialize
+    @classes = find_classes
+  end
+  
+  def [] item
+    @classes.find { |that| that.accept? item.identifier }
+  end
+  
+  private
+  def find_classes
+    Page.subclasses.sort_by { |x| x::PRIORITY }.reverse
+  end
+end

data/features/_related_tests.feature

@@ -0,0 +1,32 @@
+Feature: related tests
+
+  Scenario Outline: nanoc is ok
+    When I successfully run `ruby -S nanoc <command>`
+    Then the output should contain "<success>"
+
+    Examples:
+      | command | success |
+      |   -v    |   2007  |
+      | cs temp |  Enjoy! |
+
+      
+  Scenario: wrapper is ok
+    Given I have a blank wrapped nanoc site
+    And a directory named "lib/classes" should exist
+    And a file named "lib/classes/hide_all.rb" with:
+      """
+      class HideAll < Page
+        GOOD_ID = // # any
+        def route; nil end
+      end
+      """
+    When I successfully compile it
+    Then the file "output/index.html" should not exist
+    Then the file "output/style.css" should not exist
+    
+
+  Scenario: steps are ok
+    Given I have a default nanoc site
+    When I successfully compile it
+    Then a file named "output/index.html" should exist
+    Then a file named "output/style.css" should exist    

data/features/composite_file.example

@@ -0,0 +1,82 @@
+Feature: composite file example
+
+  Background:
+    Given I have a blank wrapped nanoc site
+    And the folowing are input files:
+      """
+      content/style/one.sass
+      content/style/two.sass
+      content/style/three.sass
+      content/style/index.erb
+      """
+    And the folowing are expected output files:
+      """
+      output/style.css
+      """
+
+  Scenario:
+    Given a file named "lib/classes/style.rb" with:
+      """
+          # different items with same routes???
+          # INDEX = ...
+          # create item?          
+          # compile_ext / route_ext ???
+          # EXT = 'css' filter an route
+          # NAME = 'style.css' # used by routing and ext ??
+          # INDEX = ...
+          # LAYOUT = ...
+          #%r|^/style/.|   # '/style/.'       
+          # '*/style' < 1 level deep
+          # '**/style' < n levels deep
+
+           #%r|^/style/.|   # <<<<<<<<<<< get rid of regexp! '*/style/*'
+              
+                              
+        class Style < Page
+          GOOD_ID = '/style/'  
+          ROUTE = '/style.css'
+        end
+
+        class SubStyle < Page
+          GOOD_ID = 'style/**'  # == '/style/**/' (boundary slashes are optional: se == /se == se/ == /se/ )
+          ROUTE = false    # nil - default action, false - dont create output file
+          FILTER = :sass   # or @@filters['sass'] = :sass # filter by ext
+        end
+      """
+    And a file named "content/style/index.erb" with:
+      """
+      <%= (+item).children.map(&:compiled_content).join "\n" %>
+      """
+    And a file named "content/style/one.sass" with:
+      """
+      html
+        color: red
+      """
+    And a file named "content/style/two.sass" with:
+      """
+      html
+        color: green
+      """
+    And a file named "content/style/three.sass" with:
+      """
+      html
+        color: blue
+      """
+    When I successfully compile it
+    Then input are the only files in "content" directory
+      And expected output are the only files in "output" directory
+      Then the file "output/style.css" should contain:
+        """
+        html {
+          color: red; }
+        """
+      Then the file "output/style.css" should contain:
+        """
+        html {
+          color: green; }
+        """
+      Then the file "output/style.css" should contain:
+        """
+        html {
+          color: blue; }
+        """