tributary 0.0.1

data/spec/tributary/item_spec.rb

@@ -0,0 +1,129 @@
+# encoding: UTF-8
+
+module Tributary describe Item do
+
+  before :all do
+    App.configure {}
+    @about     = Item.new 'spec/site/pages/about.md'
+    @battle    = Item.new 'spec/site/articles/600.md'
+    @battle_en = Item.new 'spec/site/articles/600.en.md'
+    @beep      = Item.new 'spec/site/beeps/beep.md'
+    @bi_en     = Item.new 'spec/site/articles/bilingual.en.md'
+    @bi_pl     = Item.new 'spec/site/articles/bilingual.pl.md'
+    @unix      = Item.new 'spec/site/articles/unix-millennium-bug.en.md'
+    @welcome   = Item.new 'spec/site/articles/welcome.md'
+  end
+
+  context '#<=>' do
+
+    it 'sorts Items by date, date-less last' do
+      [@bi_en, @beep, @welcome, @about, @battle].sort.should == [@battle, @bi_en, @welcome, @beep, @about]
+    end
+
+    it 'sorts same-path Items by lang, based on App.locale' do
+      App.locale = 'pl'
+      [@bi_en, @bi_pl].sort.should      == [@bi_pl, @bi_en]
+      [@battle_en, @battle].sort.should == [@battle, @battle_en]
+      App.locale = 'en'
+      [@bi_pl, @bi_en].sort.should      == [@bi_en, @bi_pl]
+      [@battle, @battle_en].sort.should == [@battle_en, @battle]
+      App.locale = nil
+      [@bi_pl, @bi_en].sort.should      == [@bi_en, @bi_pl]
+      [@battle_en, @battle].sort.should == [@battle, @battle_en]
+    end
+
+  end
+
+  context '#body' do
+
+    it 'returns the given Item’s markdown-processed body' do
+      @about.body.should   == "<p>tributary <em>about</em> page</p>\n\n<p>about this tributary install</p>\n"
+      @welcome.body.should == "<p>tributary <em>welcome</em> article</p>\n"
+    end
+
+  end
+
+  context '#date' do
+
+    it 'returns the given Item’s parsed Time' do
+      @about.date.should   == nil
+      @battle.date.should  == Time.mktime(2010, 7, 15, 12, 00)
+      @unix.date.should    == Time.utc(2038, 1, 19,  3, 14, 07)
+      @welcome.date.should == Time.mktime(2010, 7, 15)
+    end
+
+  end
+
+  context '#eql?' do
+
+    it 'returns predicate for sane use of Items as Hash keys' do
+      @about.should be_eql Item.new('spec/site/pages/about.md')
+    end
+
+  end
+
+  context '#hash' do
+
+    it 'returns static value for sane use of Items as Hash keys' do
+      @about.hash.should == Item.new('spec/site/pages/about.md').hash
+    end
+
+  end
+
+  context '#lang' do
+
+    it 'returns the Item’s language (if defined)' do
+      @about.lang.should == nil
+      @bi_en.lang.should == 'en'
+      @bi_pl.lang.should == 'pl'
+    end
+
+  end
+
+  context '#path' do
+
+    it 'returns the given Item’s path' do
+      @about.path.should  == 'about'
+      @battle.path.should == '600'
+      @bi_en.path.should  == 'bilingual'
+      @bi_pl.path.should  == 'bilingual'
+    end
+
+  end
+
+  context '#published?' do
+
+    it 'returns whether the given Item has a date in the past' do
+      @about.should_not be_published
+      @battle.should    be_published
+      @unix.should_not  be_published
+      @welcome.should   be_published
+    end
+
+  end
+
+  context '#title' do
+
+    it 'returns the given Item’s YAML-specified title' do
+      @about.title.should   == 'about tributary'
+      @welcome.title.should == 'welcome to tributary'
+    end
+
+    it 'returns elided body if the YAML-specified title is missing' do
+      Item.new('spec/site/beeps/beep.md').title.should  == 'beep…'
+      Item.new('spec/site/beeps/link.md').title.should  == 'Qué…'
+      Item.new('spec/site/beeps/quote.md').title.should == 'An…'
+    end
+
+  end
+
+  context '#type' do
+
+    it 'returns the given Item’s type' do
+      @about.type.should   == :pages
+      @welcome.type.should == :articles
+    end
+
+  end
+
+end end

data/spec/tributary/plugins/dummy_spec.rb

@@ -0,0 +1,12 @@
+module Tributary describe Plugins::Dummy do
+
+  context '#handle' do
+
+    it 'returns an unmodified Item' do
+      item = mock Item
+      Plugins::Dummy.new.handle(item).should equal item
+    end
+
+  end
+
+end end

data/spec/tributary/plugins/mnml_spec.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+module Tributary describe Plugins::Mnml do
+
+  context '#handle' do
+
+    it 'minimalises the given Item’s title and body' do
+      item = mock Item, body: 'a wonderful body', title: 'an interesting title'
+      mnml = Plugins::Mnml.new.handle item
+      mnml.body.should  == ' wndrfl bd'
+      mnml.title.should == 'n ntrstng ttl'
+    end
+
+  end
+
+end end

data/spec/tributary/plugins/unbreak_my_art_spec.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+
+module Tributary describe Plugins::UnbreakMyArt do
+
+  def unbreak string
+    Plugins::UnbreakMyArt.new.handle(mock Item, body: string).body
+  end
+
+  describe '#handle' do
+
+    it 'prevents line wrapping after single-letter words' do
+      unbreak('give me a break').should == 'give me a break'
+    end
+
+    it 'prevents line wrapping after line-starting single-letter words' do
+      unbreak('a fish!').should          == 'a fish!'
+      unbreak("this is\na fish!").should == "this is\na fish!"
+    end
+
+    it 'does not alter one-letter HTML tags' do
+      unbreak("<a href='http://en.wikipedia.org/wiki/Invisible_Pink_Unicorn'>I want to believe</a>").should == "<a href='http://en.wikipedia.org/wiki/Invisible_Pink_Unicorn'>I want to believe</a>"
+    end
+
+    it 'allows for optional trailing punctuation' do
+      unbreak('I, Clau-Clau-Claudius').should == 'I, Clau-Clau-Claudius'
+    end
+
+    it 'unbreaks bodies and titles' do
+      unbroken = Plugins::UnbreakMyArt.new.handle mock Item, title: 'about a ninja', body: 'and a pirate'
+      unbroken.title.should == 'about a ninja'
+      unbroken.body.should  == 'and a pirate'
+    end
+
+  end
+
+end end

data/spec/tributary/stream_spec.rb

@@ -0,0 +1,155 @@
+# encoding: UTF-8
+
+module Tributary describe Stream do
+
+  before :all do
+    @about   = Item.new 'spec/site/pages/about.md'
+    @battle  = Item.new 'spec/site/articles/600.md'
+    @btl_en  = Item.new 'spec/site/articles/600.en.md'
+    @bi_en   = Item.new 'spec/site/articles/bilingual.en.md'
+    @bi_pl   = Item.new 'spec/site/articles/bilingual.pl.md'
+    @dated   = Item.new 'spec/site/beeps/dated.md'
+    @english = Item.new 'spec/site/beeps/english.en.md'
+    @polish  = Item.new 'spec/site/beeps/polish.pl.md'
+    @unix    = Item.new 'spec/site/articles/unix-millennium-bug.en.md'
+    @welcome = Item.new 'spec/site/articles/welcome.md'
+  end
+
+  before :each do
+    App.configure { |config| config.set :root, 'spec/site' }
+    @stream = Stream.new
+  end
+
+  context '#initialize' do
+
+    it 'filters the Items through the provided Plugins' do
+      App.plugins = [Plugins::Mnml.new]
+      plugged = Stream.new
+      @stream.recent.map(&:title).should == ['ten…', 'this…', '600th anniversary (intl.)', 'bilinguality', 'a…', 'welcome to tributary']
+      plugged.recent.map(&:title).should == ['tn…',  'ths…',  '600th nnvrsr (ntl.)',       'blnglt',       '…',  'wlcm t trbtr']
+    end
+
+  end
+
+  context '#langs' do
+
+    it 'returns an Array of langs used in the Items' do
+      @stream.langs.should == ['en', 'pl']
+    end
+
+  end
+
+  context '#pick_item' do
+
+    it 'returns the relevant Item based on the provided path' do
+      @stream.pick_item('about').should        == @about
+      @stream.pick_item('welcome').should      == @welcome
+      @stream.pick_item('bilingual.en').should == @bi_en
+      @stream.pick_item('bilingual.pl').should == @bi_pl
+    end
+
+    it 'returns the first language version of an Item (if no Items match App.locale)' do
+      @stream.pick_item('bilingual').should == @bi_en
+    end
+
+    it 'returns an Item even if it’s outside of current App.lang_limit' do
+      App.lang_limit = ['pl']
+      @stream.pick_item('unix-millennium-bug').should == @unix
+    end
+
+    it 'returns the relevant language version of an Item' do
+      App.set :locale, 'en'
+      @stream.pick_item('bilingual').should == @bi_en
+      @stream.pick_item('about').should     == @about
+      App.set :locale, 'pl'
+      @stream.pick_item('bilingual').should == @bi_pl
+      @stream.pick_item('about').should     == @about
+      App.set :locale, nil
+    end
+
+  end
+
+  context '#previous' do
+
+    it 'returns an Item previous to the given Item' do
+      @stream.previous(@battle).should  == @bi_en
+      @stream.previous(@welcome).should == nil
+      @stream.previous(@about).should   == nil
+    end
+
+    it 'returns an Item previous to the Item with the same path (if the given Item’s lang != App.locale)' do
+      @stream.previous(@bi_en).should == @dated
+      @stream.previous(@bi_pl).should == @dated
+    end
+
+    it 'returns an Item previous to the given Item with the given type' do
+      @stream.previous(@bi_en).should == @dated
+      @stream.previous(@bi_en, type: :articles).should == @welcome
+    end
+
+  end
+
+  context '#recent' do
+
+    it 'returns published Items, newest-first' do
+      @stream.recent.should == [@polish, @english, @battle, @bi_en, @dated, @welcome]
+    end
+
+    it 'returns properly localised Items (if available)' do
+      App.locale = 'pl'
+      @stream.recent.should == [@polish, @english, @battle, @bi_pl, @dated, @welcome]
+      App.locale = 'en'
+      @stream.recent.should == [@polish, @english, @btl_en, @bi_en, @dated, @welcome]
+      App.locale = nil
+      @stream.recent.should == [@polish, @english, @battle, @bi_en, @dated, @welcome]
+    end
+
+    it 'returns lang_limited Items (if requested)' do
+      App.lang_limit = ['en']
+      @stream.recent.should == [@english, @battle, @bi_en, @dated, @welcome]
+      App.lang_limit = ['pl']
+      @stream.recent.should == [@polish, @battle, @bi_pl, @dated, @welcome]
+      App.lang_limit = []
+      @stream.recent.should == [@polish, @english, @battle, @bi_en, @dated, @welcome]
+    end
+
+    it 'returns a limited number of newest Items' do
+      @stream.recent(1).should == [@polish]
+    end
+
+    it 'returns a list of Items with a given type' do
+      @stream.recent(nil, type: :articles).should == [@battle, @bi_en, @welcome]
+      @stream.recent(2, type: :articles).should   == [@battle, @bi_en]
+    end
+
+  end
+
+  context '#subsequent' do
+
+    it 'returns an Item subsequent to the given Item' do
+      @stream.subsequent(@welcome).should == @dated
+      @stream.subsequent(@polish).should  == nil
+      @stream.subsequent(@about).should   == nil
+    end
+
+    it 'returns an Item subsequent to the Item with the same path (if the given Item’s lang != App.locale)' do
+      @stream.subsequent(@bi_en).should == @battle
+      @stream.subsequent(@bi_pl).should == @battle
+    end
+
+    it 'returns an Item subsequent to the given Item with the given type' do
+      @stream.subsequent(@welcome).should == @dated
+      @stream.subsequent(@welcome, type: :articles).should == @bi_en
+    end
+
+  end
+
+  context '#types' do
+
+    it 'returns an Array of the Items’ types' do
+      @stream.types.should == [:articles, :beeps, :pages]
+    end
+
+  end
+
+end end

data/tributary.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |gem|
+  gem.name     = 'tributary'
+  gem.version  = '0.0.1'
+  gem.summary  = 'tributary: a tiny, toto-inspired blogging engine'
+  gem.homepage = 'http://github.com/chastell/tributary'
+  gem.author   = 'Piotr Szotkowski'
+  gem.email    = 'chastell@chastell.net'
+
+  gem.files      = `git ls-files -z`.split "\0"
+  gem.test_files = Dir['spec/**/*.rb']
+
+  gem.add_dependency 'haml'
+  gem.add_dependency 'kramdown'
+  gem.add_dependency 'sinatra', '>= 1.1'
+  gem.add_dependency 'sinatra-r18n'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'rspec', '>= 2'
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification 
+name: tributary
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Piotr Szotkowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-31 01:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: kramdown
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sinatra-r18n
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        version: "2"
+  type: :development
+  version_requirements: *id006
+description: 
+email: chastell@chastell.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- LICENCE
+- README.md
+- Rakefile
+- config.ru
+- lib/tributary.rb
+- lib/tributary/app.rb
+- lib/tributary/item.rb
+- lib/tributary/plugins/dummy.rb
+- lib/tributary/plugins/mnml.rb
+- lib/tributary/plugins/unbreak_my_art.rb
+- lib/tributary/stream.rb
+- spec/fixtures/index.en.en+pl.xml
+- spec/fixtures/index.en.en.xml
+- spec/fixtures/index.en.xml
+- spec/fixtures/index.pl.pl.xml
+- spec/fixtures/index.pl.xml
+- spec/fixtures/index.xml
+- spec/fixtures/layout.css
+- spec/fixtures/pages.css
+- spec/site/articles/600.en.md
+- spec/site/articles/600.md
+- spec/site/articles/bilingual.en.md
+- spec/site/articles/bilingual.pl.md
+- spec/site/articles/unix-millennium-bug.en.md
+- spec/site/articles/welcome.md
+- spec/site/beeps/beep.md
+- spec/site/beeps/dated.md
+- spec/site/beeps/english.en.md
+- spec/site/beeps/link.md
+- spec/site/beeps/polish.pl.md
+- spec/site/beeps/quote.md
+- spec/site/i18n/en.yml
+- spec/site/i18n/pl.yml
+- spec/site/pages/about.md
+- spec/site/views/articles.haml
+- spec/site/views/articles.index.haml
+- spec/site/views/articles.index.sass
+- spec/site/views/articles.sass
+- spec/site/views/beeps.haml
+- spec/site/views/beeps.sass
+- spec/site/views/error.haml
+- spec/site/views/error.sass
+- spec/site/views/index.haml
+- spec/site/views/index.sass
+- spec/site/views/index.xml.haml
+- spec/site/views/layout.haml
+- spec/site/views/layout.sass
+- spec/site/views/pages.haml
+- spec/site/views/pages.sass
+- spec/tributary/app_spec.rb
+- spec/tributary/item_spec.rb
+- spec/tributary/plugins/dummy_spec.rb
+- spec/tributary/plugins/mnml_spec.rb
+- spec/tributary/plugins/unbreak_my_art_spec.rb
+- spec/tributary/stream_spec.rb
+- tributary.gemspec
+has_rdoc: true
+homepage: http://github.com/chastell/tributary
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "tributary: a tiny, toto-inspired blogging engine"
+test_files: 
+- spec/tributary/app_spec.rb
+- spec/tributary/stream_spec.rb
+- spec/tributary/item_spec.rb
+- spec/tributary/plugins/dummy_spec.rb
+- spec/tributary/plugins/unbreak_my_art_spec.rb
+- spec/tributary/plugins/mnml_spec.rb