document_tree 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+doc/*
+
+.yardoc
+.yardoc/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jaap van der Meer
+
+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.rdoc

@@ -0,0 +1,57 @@
+= document_tree
+
+DocumentTree is a gem that can read out a simple file tree. It can be used to generate a tree with documentation in Ruby on Rails, so that pages don't have to 
+be in a database.
+
+== Usage
+You must have a folder that will be read some where. For example the following example will generate a tree.
+
+- section (folder)
+  - meta.txt (file)
+  - othersection (folder)
+    - somefile.txt (file)
+    
+    
+If you now invoke DocumentTree.root.name the meta.txt is read for a real name.
+
+
+== Meta data
+All meta data is YAML format. Normal files have meta data on top of the file, splitted by line. Directories have a meta data on top of meta.txt.
+
+== Format folder meta data
+The meta data for a folder is read by reading the meta.txt of it's children.
+For example, meta.txt has the following content, the first line is the YAML meta data, the rest is +content+.
+
+  name: DocumentTree documentation
+  
+  Here comes the text, maybe formatted in some way.
+  Tralala.
+
+Now the following code:
+
+  node = DocumentTree.root 
+  node.name
+  # => DocumentTree.documentation
+  node.content
+  # => Here comes the text, maybe formatted in some way.\nTralala.
+  node.raw_name
+  # => section
+  
+
+== Finding a node
+You can search for a node by doing
+
+  DocumentTree.root.find_node("hisrawname")
+
+
+
+== Returning all nodes
+
+  DocumentTree.root.all_nodes
+
+
+
+
+== Copyright
+
+Copyright (c) 2010 Jaap van der Meer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "document_tree"
+    gem.summary = %Q{Transforms a file system in a tree with content and meta data.}
+    gem.description = %Q{}
+    gem.email = "jaapvandermeer@gmail.com"
+    gem.homepage = "http://github.com/japetheape/document_tree"
+    gem.authors = ["Jaap van der Meer"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/document_tree.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{document_tree}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jaap van der Meer"]
+  s.date = %q{2010-10-26}
+  s.description = %q{}
+  s.email = %q{jaapvandermeer@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "document_tree.gemspec",
+     "lib/document_node.rb",
+     "lib/document_tree.rb",
+     "spec/doc_tree/0001_somepage.txt",
+     "spec/doc_tree/section/other_section.txt",
+     "spec/doc_tree/section_with_meta/meta.txt",
+     "spec/doc_tree/some_page.txt",
+     "spec/document_node_spec.rb",
+     "spec/document_tree_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/japetheape/document_tree}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Transforms a file system in a tree with content and meta data.}
+  s.test_files = [
+    "spec/document_node_spec.rb",
+     "spec/document_tree_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/document_node.rb

@@ -0,0 +1,120 @@
+require 'yaml'
+class DocumentNode
+
+  def initialize(filename)
+    @filename = filename
+  end
+  
+  def children
+    files = Dir.glob(File.join(@filename, '*'))
+    files.reject {|x| /meta\.txt/.match(x) }.map{ |x| DocumentNode.new(x) }
+  end
+
+
+  def is_root?
+    @filename == DocumentTree.root.raw_filename
+  end
+  
+  def raw_filename
+    @filename
+  end
+  
+  # Is it a directory or just a file?
+  def is_leaf?
+    !File.directory?(@filename)
+  end
+  
+  # Filename
+  def filename
+    is_leaf? ? @filename : meta_file
+  end
+  
+  
+  def meta_file
+    File.join(@filename, 'meta.txt')
+  end
+  
+  
+  def meta_data
+    meta_yaml
+  end
+  
+  # The meta information of this node. If it's a file, than the meta.txt of it's child files is taken, else
+  # the file itself is taken. From this file the top part must be the YAML meta data.
+  def meta_yaml
+    if !(!is_leaf? && !File.exist?(meta_file))
+      passed = false
+      out = ""
+      File.open(filename).each_line do |line|
+        passed = true if line == "\n"
+        break if passed
+        out << line
+      end
+      YAML::load(out)
+    else
+      {:name => raw_name}
+    end
+  end
+  
+  # The content of the node, that is: the part after
+  # the yaml file.
+  def content
+    out = ""
+    passed = false
+    File.open(filename) do |f|      
+      f.each_line do |line|
+        if line == "\n" && !passed
+          passed = true 
+        else
+          out << line if passed
+        end
+      end
+    end
+    out
+  end
+  
+  # Raw folder name of this node.
+  # Strips out 0001_foldername to make positioning possible
+  def raw_name(options = {})
+    out = /.*\/[0-9]*_?(.*)(.txt)?/.match(@filename)[1]
+    out.gsub!('.txt', '') unless options[:ext]
+    out
+    #out.gsub('.txt', '') #
+    out
+  end
+
+  # Searches breadth first till name is found
+  def find_node(name)
+    to_search = self.children
+    while !to_search.empty?
+      n = to_search.pop
+      return n if n.raw_name == name
+      to_search += n.children
+    end
+    nil
+  end
+  
+  
+  # Searches breadth first till name is found
+  def all_nodes
+    all = self.children
+    to_search = self.children
+    while !to_search.empty?
+      n = to_search.pop
+      to_search += n.children
+      all += n.children
+    end
+    all
+  end
+  
+  
+  def name
+    meta_yaml['name'] || raw_name
+  end
+  
+  
+  
+  
+
+end
+

data/lib/document_tree.rb

@@ -0,0 +1,19 @@
+
+require 'document_node'
+module DocumentTree
+  
+  
+  class << self
+    attr_accessor :location
+    def location
+      @location || (defined?(Rails) ? File.join(Rails.root, 'app', 'docs') : 'docs')
+    end
+
+    
+    def root
+      @root ||= DocumentNode.new(self.location)
+    end
+  end
+
+end
+

data/spec/doc_tree/0001_somepage.txt

@@ -0,0 +1,3 @@
+name: haha
+
+test

data/spec/doc_tree/section/other_section.txt

@@ -0,0 +1,5 @@
+name: adsfadasd
+
+asdasdasd
+asd
+asdasdasd

data/spec/doc_tree/section_with_meta/meta.txt

@@ -0,0 +1,3 @@
+name: Some section
+
+sdfsdf

data/spec/doc_tree/some_page.txt

@@ -0,0 +1,3 @@
+name: "Men"
+
+Testerdetest

data/spec/document_node_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+require 'document_tree'
+require 'document_node'
+include DocumentTree
+
+describe DocumentNode do
+  
+  
+  it "should have some children" do
+    DocumentTree.root.children.size.should > 0
+    DocumentTree.root.children.first.kind_of?(DocumentNode).should be true
+  end
+  
+  it "should have a folder with children" do
+    folder_with_children = false
+    DocumentTree.root.children.each do |c|
+      folder_with_children = folder_with_children || !c.children.empty?
+    end
+    folder_with_children.should == true
+  end
+  
+  
+  it "should read meta data of a directory without meta.txt" do
+    DocumentTree.root.children[1].is_leaf?.should == false
+    DocumentTree.root.children[1].meta_data[:name].should == "section"
+  end
+  
+  
+  it "should read meta data of a file with meta.txt" do
+    node = DocumentTree.root.children[2]
+    node.children.empty?.should == true
+    node.is_leaf?.should == false
+    File.exist?(node.meta_file).should == true
+    node.name.should == "Some section"
+    node.content.should == "sdfsdf"
+  end
+  
+  
+  it "should read meta data of a normal file" do
+    node = DocumentTree.root.children[3]
+    node.meta_data['name'].should == "Men"
+    node.content.should == "Testerdetest"
+  end
+
+
+  it "should find a node" do
+    found = DocumentTree.root.find_node('other_section')
+    found.should_not be_nil
+  end
+  
+  it "should have all nodes" do
+    all = DocumentTree.root.all_nodes
+    all.length.should == 5
+  end
+
+
+  it "should have a name and stuff like that" do
+    node = DocumentTree.root.find_node("other_section")
+    node.name.should == "adsfadasd"
+    node.content.should == "asdasdasd\nasd\nasdasdasd"
+  end
+
+  it "should have a name" do
+    node = DocumentTree.root
+    node.name.should == "doc_tree"
+  end
+
+  describe "#raw_name" do
+    it "should take a :txt options" do
+      node = DocumentTree.root.find_node("other_section")
+      node.raw_name.should == "other_section"
+      node.raw_name(:ext => true).should == "other_section.txt"
+    end
+  end
+  
+  it "should be root" do
+    DocumentTree.root.is_root?.should == true
+  end
+  
+  
+  it "should strip the 0001_" do 
+    DocumentTree.root.children[0].raw_name.should == "somepage"
+  end
+
+end

data/spec/document_tree_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+require 'document_tree'
+require 'document_node'
+include DocumentTree
+
+describe DocumentTree do
+  
+  it "should be able to set another location" do
+    DocumentTree.location.should_not be_nil
+
+  end
+  
+  it "should have a root node" do
+    DocumentTree.root.should_not be_nil
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+
+require 'document_tree'
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+DocumentTree.location = File.join( File.dirname(__FILE__), 'doc_tree')
+
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  #config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  # config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: document_tree
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jaap van der Meer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-26 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: ""
+email: jaapvandermeer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- document_tree.gemspec
+- lib/document_node.rb
+- lib/document_tree.rb
+- spec/doc_tree/0001_somepage.txt
+- spec/doc_tree/section/other_section.txt
+- spec/doc_tree/section_with_meta/meta.txt
+- spec/doc_tree/some_page.txt
+- spec/document_node_spec.rb
+- spec/document_tree_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/japetheape/document_tree
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Transforms a file system in a tree with content and meta data.
+test_files: 
+- spec/document_node_spec.rb
+- spec/document_tree_spec.rb
+- spec/spec_helper.rb