jbe-Nest 1.2.0

data/README.textile

@@ -0,0 +1,112 @@
+
+h1. Nest
+
+h2. YAML file tree object wrapper in Ruby
+
+Nest is an object wrapper for mounting and reading data from trees of multiple YAML files. You may think of it as a mapping between files and objects. While this may reek of meta (shrug), it it does real world® usage.
+
+h3. Installation
+
+@gem sources -a http://gems.github.com@ if you haven't already.
+@sudo gem install jbe-nest@
+
+h2. Explaination and usage
+
+The nest data model has:
+
+* A mount point in some file system
+* A corresponding root node
+* Zero or more ascending nodes
+
+Every node has:
+
+* Any number of properties (described in YAML)
+* Zero or more ascending files
+
+I wrote nest as a file based data model for a website, where every node corresponded to a viewable page, and aditional contents was kept in files.
+
+This is an example of a mountable nest directory structure:
+
+<pre>
+<code>
+doc/
+  index.yml
+  about.yml
+  blob.file
+  fruits/
+    index.yml
+    apple.yml
+    banana/
+      index.yml
+      banana.jpg
+</code>
+</pre>
+
+This gives the following tree of nodes, excluding files:
+
+<pre>
+<code>
+/
+  about
+  fruits
+    apple
+    banana
+</code>
+</pre>
+
+The @root@ node also contains @blob.file@, and @banana@ also contains @banana.jpg@. All of this is available in the object model. Every node contains it's own YAML.
+
+Every node will have a uri corresponding to it's path in the above tree, such as @/fruits/banana@. This is useful when you need urls.
+
+h3. Synopsis
+
+<pre>
+<code>
+class Library
+   include Nest
+   mount './doc'
+end
+
+l = Library.root
+
+l.properties  # available methods
+l.children
+l.parent
+l.files
+
+</code>
+</pre>
+
+h2. Why is this useful?
+
+For highly customizeable, file based taxonomies, ie. websites. Let each *.yaml correspond to a page, and contain metainformation, including styles and layout instructions. Keep additional content in files, in accordance with that particular implementation.
+
+
+h3. TODO
+
+* Write tests
+
+h3. LICENSE
+
+(MIT License)
+
+Copyright (c) 2009 Jostein Berre Eliassen
+
+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/lib/nest.rb

@@ -0,0 +1,136 @@
+
+require 'rubygems'
+require 'yaml'
+
+
+
+module Nest
+
+  module ClassMethods
+
+    attr_reader :mount_point
+
+    def mount( path )
+      @mount_point = path
+      raise "invalid path" unless valid?
+    end
+
+    def valid?
+      root.valid?
+    end
+
+    def root
+      new '/'
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  attr_reader :uri
+
+  def initialize( uri )
+    raise 'nest not mounted' unless self.class.mount_point
+    @uri = sanitize( uri )
+    raise 'invalid uri' unless valid?
+  end
+
+  def base_path
+    File.join(self.class.mount_point, @uri)
+  end
+
+  def index_path
+    File.join(base_path, 'index.yml')
+  end
+
+  def file_path
+    base_path + '.yml'
+  end
+
+  def node_type
+    if File.file?(index_path)
+                                    :index
+    elsif File.file?(file_path)
+                                    :file
+    elsif File.file?(base_path)
+                                    :object
+    elsif File.directory?(base_path)
+                                    :object_group
+    else
+                                    :error
+    end
+  end
+
+  def data_path
+    case node_type
+      when :index
+        index_path
+      when :file
+        file_path
+      else
+        raise 'not a data node'
+    end
+  end
+
+  def valid?
+    node_type != :error
+  end
+
+  def properties
+    YAML.load_file data_path
+  end
+
+  def []( name )
+    properties[name.to_s]
+  end
+
+  def method_missing( name )
+    self[name]
+  end
+
+  def children
+    retrieve_sub( :file, :index )
+  end
+
+  def indexes
+    retrieve_sub( :index )
+  end
+
+  alias :indices :indexes
+
+  def endpoints
+    retrieve_sub( :file )
+  end
+
+  def files
+    retrieve_sub( :object )
+  end
+
+  def file_groups
+    retrieve_sub( :file_group )
+  end
+
+  def parent
+    raise 'parent not implemented'
+  end
+
+
+  private
+
+    def retrieve_sub( *node_types_requested )
+      Dir.new(base_path).entries.map do |path|
+        unless ['.', '..', 'index.yml'].include? path
+          path.gsub! /\.yml$/, ''
+          x = self.class.new( File.join( @uri, path ))
+          node_types_requested.include?( x.node_type ) ? x : nil
+        end
+      end.compact.uniq
+    end
+
+    def sanitize( uri )
+      File.join( '/',
+      *uri.split(/\/|\\/).select{|x| !x.match( /^\.+$/ )} )
+    end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+name: jbe-Nest
+version: !ruby/object:Gem::Version 
+  version: 1.2.0
+platform: ruby
+authors: 
+- Jostein Berre Eliassen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Ruby YAML file tree object wrapper
+email: jbe@svusj.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.textile
+- lib/nest.rb
+has_rdoc: false
+homepage: http://github.com/jbe/nest
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby YAML file tree object wrapper
+test_files: []
+