dirk 0.1.0

data/lib/dirk.rb

@@ -0,0 +1,136 @@
+require 'yaml'
+# require 'image_fu'
+
+class Dirk
+  attr_reader :path, :attributes, :attr_file
+
+  def self.dir
+    ""
+  end    
+
+  def initialize(p = "", options = {})
+    @prefix     = options[:prefix] || "_"
+    @attr_file  = @prefix + (options[:attr_file] || "attributes.txt")
+    @root_path  = Pathname.new(options[:root] || "public/data")
+    @path       = (@root_path + self.class.dir + p).realpath
+    @attributes = get_attributes
+  end            
+
+  # used to access the attributes of the current object
+  def method_missing(name, *args, &block)
+    @attributes ? @attributes[name.to_s] : nil
+  end
+
+  def name
+    slug.gsub(/_/, " ").split(".")[0]
+  end
+
+  def slug
+    path.basename.to_s
+  end
+  
+  # returns the path relative to the root_path for the application
+  def relative_path(p = path)
+    anchor = p.ftype == "directory" ? @root_path : "public"
+    p.relative_path_from(Pathname.new(anchor).realpath)
+  end
+
+  # returns the url corresponding to the path
+  def url(p = path)
+    "/" + relative_path(p).to_s.downcase.gsub(/\s/, " ")
+  end
+
+  def extension
+    @path.extname[1..-1]
+  end
+
+  def parent
+    Dirk.new(@path.parent)
+  end
+
+  # creates a hash of Dirk objects for any non-system sub-directories of the current directory
+  def children(options = {})
+    children = get_children("directory").collect { |child| Dirk.new(child) }
+    children.reject! { |child| child.published == false || child.draft == true }
+    children.sort! { |a, b| a.send(options[:sort]).to_s <=> b.send(options[:sort]).to_s } if options[:sort]
+    children.reverse if options[:order].to_s.upcase == "DESC"
+    children
+  end
+
+  # creates a hash of Dirk objects for any non-system files in the current directory
+  def files(options = {})
+    resize_images_if_needed  
+    files = get_children("file").collect do |file| 
+      Dirk.new(file, { :attr_file => file.basename.to_s.gsub(file.extname, '.txt') })
+    end
+  
+    files.sort! { |a, b| a.send(options[:sort]).to_s <=> b.send(options[:sort]).to_s } if options[:sort]
+    files
+  end
+
+  def thumb_path
+    thumb_path = Pathname.new(parent.path.realpath.to_s + "/#{@prefix}thumbs/" + path.basename)
+    create_thumbnail(path) unless thumb_path.exist?
+    thumb_path.realpath
+  end
+
+  def thumb_url
+    url(thumb_path)
+  end
+
+  private
+
+  def resize_images_if_needed
+    resize_path = Pathname.new(path.parent.realpath.to_s + "/#{@prefix}resize/")
+
+    if resize_path.exist?
+      back_path = (file.dirname).realpath.to_s + "/#{@prefix}backup"
+      FileUtils.mkdir_p back_dir unless File.exists?(back_dir)
+      FileUtils.mv(file, back_dir)
+      
+      resize_path.entries.each do |image_path|
+        convert_size(image_path, path.parent.real_path)
+      end
+    end
+  end
+
+  def convert_size(file, destination)
+    %x{convert #{destination + "/" + file.basename} -resize 1000x1000 #{file}}
+  end
+
+  def get_children(type = %w{directory file})
+    @path.children.
+      reject { |child| [@prefix, "."].include?(child.basename.to_s[0..0]) }.
+      reject { |child| not [*type].include?(child.ftype) }
+  end
+
+  def get_attributes
+    file_contents = read_file(@attr_file)
+    return YAML::load(file_contents) if file_contents
+    {}
+  end
+
+  #TODO needs re-factoring - path should only be the directory and the file should be separate
+  def read_file(file)
+    text_file = (path.ftype == "directory" ? path : Pathname.new(path.dirname)) + file
+    File.read(text_file) if File.exists?(text_file)
+  end
+
+end
+
+class FileAttributes
+  def initialize(file)
+    return false unless file && !File.exists?(file)
+    contents = File.read(file)
+    @attribs = YAML::load(contents) if contents
+  end
+  
+  def read(filename)
+    @attribs[filename]["title"]
+  end
+  
+  def keys(filename)
+    @attribs[filename].keys
+  end
+  
+end

data/lib/processes/read_file.rb

@@ -0,0 +1,19 @@
+require 'faster_csv'
+
+module Process
+  def contents(file)
+    case file.extname
+    when "txt":      
+      file_contents = read_file(file)
+      return YAML::load_stream(file_contents).documents if file_contents
+    when "csv":
+      return FasterCSV.for_each load(file_contents) if %w{txt yml}.include?(file.extname)
+    end
+    {}
+  end
+  
+  def read_file(file)
+    text_file = (path.ftype == "directory" ? path : Pathname.new(path.dirname)) + file
+    File.read(text_file) if File.exists?(text_file)
+  end    
+end

data/test/fixtures/data/_attributes.txt

@@ -0,0 +1,6 @@
+title: Portfolio Site
+sub_title: This is the portfolio of a madman.
+body: |
+  Welcome to the terrordome.
+  We do things differently inside.
+  There is no place to hide.

data/test/fixtures/data/portfolio/project_2/_attributes.txt

@@ -0,0 +1,3 @@
+title: Project 2
+sub_title: This is a really great project
+date: 2009

data/test/fixtures/data/portfolio/project_2/_file_attributes.txt

@@ -0,0 +1,6 @@
+"image_1.jpg":
+  title: "A title beyond all titles"
+  description: "Some more meta data for your delectation"
+"image_2.jpg":
+  title: "A title that's not as good as some other titles, but not bad nontheless"
+  description: "Yep, data is the meat on the bones"

data/test/fixtures/data/portfolio/project_3/^attributes.txt

@@ -0,0 +1,2 @@
+title: This is project 3
+sub_title: This is a really great project.

data/test/test_dirk.rb

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'test/unit'
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib dirk]))
+
+class Projects < Dirk
+  def self.dir
+    "portfolio"
+  end
+end
+
+class TestDirk < Test::Unit::TestCase
+  def setup
+    test_root     = File.join(File.dirname(__FILE__), 'fixtures', 'data')
+    @test_options = { :root => test_root }
+    
+    @root               = Dirk.new("", @test_options )
+    @projects           = Projects.new("", @test_options )
+    @first_project      = Dirk.new("portfolio/project_1", @test_options )
+    @second_project     = Dirk.new("portfolio/project_2", @test_options )
+    @second_sub_project = Dirk.new("portfolio/project_2/sub-project_2", @test_options )
+    @image_1            = Pathname.new(test_root) + "portfolio/project_2/image_1.jpg"
+    @image_2            = Pathname.new(test_root) + "portfolio/project_2/image_2.jpg"
+  end
+  
+  def test_subclass_can_set_starting_directory
+    assert_equal @projects.path, Dirk.new("portfolio", @test_options ).path
+  end
+  
+  def test_dirk_correctly_counts_files
+    assert_equal 0, @root.files.size
+    assert_equal 1, @second_sub_project.files.size
+    assert_equal 2, @second_sub_project.parent.files.size
+  end
+  
+  def test_dirk_correctly_shows_files
+    assert_equal @image_1, @projects.children[1].files[0].path
+    assert_equal [@image_1, @image_2], @second_sub_project.parent.files.collect { |file| file.path }
+  end
+  
+  def test_dirk_correctly_counts_children
+    assert_equal 3, @root.children.size
+  end
+  
+  def test_dirk_correctly_reads_parent
+    assert_equal @root.path, @root.children.first.parent.path
+    assert_equal @root.title, @root.children.first.parent.title
+  end
+  
+  def test_dirk_correctly_traverses_heirarchy
+    assert_equal "portfolio", @root.children[2].path.basename.to_s
+  end
+  
+  def test_dirk_correctly_computes_object_directory
+    assert_equal @second_sub_project.path, @root.children[2].children[1].children[1].path
+  end
+
+  def test_dirk_correctly_reads_attributes
+    assert_equal "Portfolio Site", @root.title
+    assert_equal "This is the portfolio of a madman.", @root.sub_title
+    assert_equal "Welcome to the terrordome.\nWe do things differently inside.\nThere is no place to hide.", @root.body
+    assert_equal "Project 2", @second_sub_project.parent.title
+    assert_equal "This is a really great project", @second_sub_project.parent.sub_title
+  end
+  
+  def test_dirk_accepts_root_override
+    assert true
+  end
+  
+  def test_dirk_accepts_prefix_override
+    project = Dirk.new("portfolio/project_3", @test_options.merge({:prefix => "^"}) )
+    assert_equal "This is project 3", project.title
+  end
+  
+  def test_dirk_returns_slug
+    assert_equal "image_1.jpg", Dirk.new(@image_1).slug
+  end
+  
+  def test_dirk_returns_name
+    assert_equal "image 1", Dirk.new(@image_1).name
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: dirk
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- James Andrews
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: me@jamesandre.ws
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- test/fixtures/data/_attributes.txt
+- test/fixtures/data/news/_2009-04-36.txt
+- test/fixtures/data/portfolio/project_1/_attributes.txt
+- test/fixtures/data/portfolio/project_1/sub-project_1/_attributes.txt
+- test/fixtures/data/portfolio/project_1/sub-project_2/_attributes.txt
+- test/fixtures/data/portfolio/project_1/sub-project_3/_attributes.txt
+- test/fixtures/data/portfolio/project_2/_attributes.txt
+- test/fixtures/data/portfolio/project_2/_file_attributes.txt
+- test/fixtures/data/portfolio/project_2/image_1.jpg
+- test/fixtures/data/portfolio/project_2/image_2.jpg
+- test/fixtures/data/portfolio/project_2/sub-project_1/_attributes.txt
+- test/fixtures/data/portfolio/project_2/sub-project_2/broken_image_1.jpg
+- test/fixtures/data/portfolio/project_3/^attributes.txt
+- test/test_dirk.rb
+- lib/dirk.rb
+- lib/processes/read_file.rb
+has_rdoc: true
+homepage: http://jamesandre.ws
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: dirk
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Makes your file system act as a database
+test_files: []
+