mokuji 0.2.2 → 1.0.0

data/Mokuji.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   s.authors     = ['Icid Asset']
   s.email       = ['icid.asset@gmail.com']
   s.homepage    = 'http://icidasset.heroku.com/'
-  s.summary     = %q{Mokuji makes lists from directories}
-  s.description = %q{Make a list from the directory contents and export it in JSON or HTML}
+  s.summary     = %q{Mokuji recursively lists a directory by its path.}
+  s.description = %q{Make a recursive list from a directory its contents and export it in html, json or plain-text}
   
   s.rubyforge_project = "mokuji"
   

data/README

@@ -1,6 +1,5 @@
 INSTALL
 gem install mokuji
 
-
 USAGE
 Type in 'mokuji' in your terminal

data/Rakefile

@@ -1,17 +1,10 @@
 require 'rubygems'
 
-
 unless ENV['NOBUNDLE']
-
-	begin
-	
-		require 'bundler'
-		Bundler::GemHelper.install_tasks
-		
-	rescue LoadError
-	
-		puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-		
-	end
-
+  begin
+    require 'bundler'
+    Bundler::GemHelper.install_tasks
+  rescue LoadError
+    puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  end
 end

data/bin/mokuji

@@ -5,78 +5,31 @@ require 'mokuji'
 require 'rubygems'
 require 'thor'
 
-
 class Moki < Thor
-
-
-
-	desc "scan PATH (EXPORT_PATH) (OUTPUT_TYPE)", "Scan a directory by its path. You can also set the export path for the file. Both can be relative paths. The default export path is the same as the path you want to scan. Next to that, you can also set the output type. The options for that are JSON and HTML. Which defaults to HTML."
-	
-	def scan path_to_scan, export_path = nil, output_type = 'html'
-	  
-	  # Check if the given output type exists
-	  unless output_type.match(/^(html|json)$/)
-	  
-	    say "Errr, that output type doesn't exist =/", :red
-	    
-	    exit
-	  
-	  end
-	
-		# Convert the paths to absolute paths
-		path_to_scan = File.expand_path(path_to_scan)
-		export_path = File.expand_path(export_path) if export_path
-		
-		# Check if the directory exists
-		unless File.directory?(path_to_scan) then
-		
-			say "The directory that you want to scan, does not exist.", :red
-			
-			exit
-		
-		end
-		
-		# Check if the directory isn't empty
-		if Dir.entries(path_to_scan).slice(2..-1).empty? then
-		
-			say "The directory that you want to scan, is empty."
-			
-			exit
-		
-		end
-		
-		# New Mokuji
-		moki = Mokuji::Initializer.new
-		moki.path_to_scan = path_to_scan
-		
-		# Export path check if given
-		if export_path then
-		
-			unless File.directory?(export_path) then
-			
-				say "The directory that you want to export to, does not exist.", :red
-				
-				exit
-			
-			else
-			
-				moki.export_path = export_path
-			
-			end
-		
-		end
-		
-		# Please continue
-		moki.converting_method = output_type.to_sym
-		moki.execute
-		
-		say "Directory list successfully created! =D", :green
-	
-	end
-
-
-
+  desc "list PATH (EXPORT_PATH)", "Recursively list a directory by its path."
+  long_desc %Q{
+    Recursively list a directory by its path.
+    You can also set the export path for the file.
+    Both can be relative paths.
+    The default export path is the same as the first path.
+  }
+  
+  method_options :show_dot_files => :boolean, :output_type => :string
+  
+  def list import_path, export_path = nil 
+    # Convert the paths to absolute paths
+    import_path = File.expand_path(import_path)
+    export_path = File.expand_path(export_path) if export_path
+    
+    # New list
+    begin
+      Mokuji.configure options
+      Mokuji.make_list import_path, export_path
+      say "Your list has been cooked successfully!", :green
+    rescue RuntimeError => error_message
+      say error_message.to_s, :red
+    end
+  end
 end
 
-
 Moki.start

data/lib/mokuji.rb

@@ -1,11 +1,78 @@
-require 'mokuji/initializer'
+require 'mokuji/validators'
+require 'mokuji/scanner'
+require 'mokuji/converter'
+require 'mokuji/exporter'
 
 module Mokuji
-
-	#
-	# 	MOKUJI LIB PATH
-	#
-	
-	LIB_PATH = File.dirname(__FILE__)
-
+  #
+  # === Info
+  #
+  # Mokuji makes recursive lists of directories
+  # and outputs it in html, plain-html, json or plain-text files.
+  #
+  # === How to use
+  #
+  # require 'mokuji'
+  #
+  # Mokuji.make_list import_path, export_path # export path is optional
+  #
+  # === You could also
+  #
+  # Mokuji.configure :hide_dot_files => false
+  # Mokuji.make_list import_path # Make a list with the dot files included
+  # Mokuji.configure :output_type => 'json'
+  # Mokuji.make_list import_path # Make another list in the json format
+  #
+  # === Example with Thor
+  #
+  # begin
+  #  Mokuji.configure options
+  #  Mokuji.make_list import_path, export_path
+  #  say "BOOM! DONE!", :green
+  # rescue RuntimeError => error_message
+  #  say error_message.to_s, :red
+  # end
+  
+  LIB_PATH = File.expand_path File.dirname(__FILE__)
+  
+  DEFAULTS = {
+    'show_dot_files'   =>  false,     # Scanner options
+    'output_type'      =>  'html',   # Converter options
+    'list_name'        =>  nil       # Global options
+  }
+  
+  def self.configure options = {}
+    Mokuji::Validators.validate_options(options)
+    @config = unless @config
+      DEFAULTS.merge(options)
+    else
+      @config.merge(options)
+    end
+  end
+  
+  def self.configuration
+    return @config ||= DEFAULTS.clone
+  end
+  
+  def self.make_list import_path, export_path = nil
+    scan_results = self.scan import_path
+    converter_results = self.convert(scan_results)
+    export_path ||= import_path
+    self.export converter_results, export_path
+  end
+  
+  def self.scanner; Mokuji::Scanner.new; end
+  def self.scan path
+    return self.scanner.scan(path)
+  end
+  
+  def self.converter; Mokuji::Converter.new; end
+  def self.convert hash
+    return self.converter.convert(hash)
+  end
+  
+  def self.exporter; Mokuji::Exporter.new; end
+  def self.export string, export_path
+    return self.exporter.export(string, export_path)
+  end
 end

data/lib/mokuji/converter.rb

@@ -1,175 +1,162 @@
-module Mokuji
+require 'mokuji/validators'
 
-	#
-	# 	CONVERTER
-	# 	- Converts the data from the scanner to JSON or HTML
-	#
-	# 	{ return => String }
-	#
+module Mokuji
+  #
+  # { CONVERTER }
+  #
+  # === Info
+  #
+  # Converts the data from the scanner to JSON or HTML
+  #
+  # === Output example : String
+  #
+  # <html>
+  #  ...
+  #  <body>
+  #   <h1>Icid</h1>
+  #   <h2>19 April 2011 (03:47PM)</h2>
+  #   <nav>
+  #    <a id="expand_all">Expand all directories</a> ---
+  #    <a id="close_all">Close all directories</a>
+  #   </nav>
+  #   <ul id="list"><li class="file">file.txt</li></ul>
+  #  </body>
+  #  ...
+  # </html>
+  #
+  # === How to use
+  #
+  # converter           =   Mokuji::Converter.new
+  # converter_results   =   converter.convert data_from_scanner
 
-	class Converter
-	
-	
-	
-		attr_accessor :data_from_scanner, :converting_method, :list_name, :time
-		
-		
-		
-		def execute
-		
-			# Data validation
-			data_validation
-			
-			# Time check
-			raise 'Time not set' unless time
-			
-			# Process the data
-			data = case converting_method
-			
-				when :json then toJSON
-				when :html then toHTML
-			
-			end
-		
-		end
-		
-		
-		
-		protected
-		
-		
-		
-		def data_validation
-		
-			# Check if the Object isn't empty
-			if data_from_scanner.empty? then
-			
-				raise 'No data <.<'
-			
-			else
-			
-				case converting_method
-				
-					when :json then raise_error_unless_data_is(Array)
-					when :html then raise_error_unless_data_is(Hash)
-					
-					else
-						raise 'The given converting method is unknown'
-				
-				end
-			
-			end
-		
-		end
-		
-		
-		
-		def raise_error_unless_data_is thisClass
-		
-			# Check if the class of the data Object is what it should be
-			if data_from_scanner.class != thisClass then
-			
-				raise 'If you want to convert data, it should be a(n): ' + thisClass.to_s
-			
-			end
-		
-		end
-		
-		
-		
-		def toJSON
-		
-			require 'json'
-			
-			hash = {
-			
-				"list_name"		=>	list_name,
-				"made_on"		=>	time,
-				"contents"		=>	data_from_scanner
-			
-			}
-			
-			hash.to_json
-		
-		end
-		
-		
-		
-		def toHTML
-		
-			# Convert the data from the scanner to html
-			html_data = toHTML_readContentsFrom( data_from_scanner['contents'] )
-			
-			# Loading some assets
-			assets_path = if defined? Mokuji::LIB_PATH then
-						
-							Mokuji::LIB_PATH + '/mokuji/assets/'
-						
-						else
-						
-						'./lib/mokuji/assets/'
-						
-						end
-			
-			minified_jquery = IO.read(assets_path + 'jquery-1.5.min.js')
-			javascript_code = IO.read(assets_path + 'code.js')
-			stylesheet = IO.read(assets_path + 'stylesheet.css')
-			
-			# And push everything into the html template
-			html_template = %{
-			
-				<!doctype html>
-				<html>
-					<head>
-						<meta charset="utf-8">
-						<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-						<title>#{list_name}</title>
-						<style>#{stylesheet}</style>
-					</head>
-					<body>
-						<h1>#{list_name}</h1>
-						<h2>#{time}</h2>
-						<nav>
-							<a id="expand_all">Expand all directories</a> ---
-							<a id="close_all">Close all directories</a>
-						</nav>
-						<ul id="list">#{html_data}</ul>
-					<script>#{minified_jquery}</script>
-					<script>#{javascript_code}</script>
-					</body>
-				</html>
-			
-			}.strip.gsub(/\t/, '')
-		
-		end
-		
-		
-		
-		def toHTML_readContentsFrom array
-		
-			html = ''
-			
-			array.each do |hash|
-			
-				if hash['type'] == 'directory' then
-				
-					html << '<li class="directory"><span>' + hash['name'] + '</span>'
-					html << '<ul>' + toHTML_readContentsFrom( hash['contents'] ) + '</ul></li>'
-				
-				else
-				
-					html << '<li class="file">' + hash['name'] + '</li>'
-				
-				end
-			
-			end
-			
-			return html
-		
-		end
-	
-	
-	
-	end # </Converter>
+  class Converter
+    include Mokuji::Validators
+    
+    attr_reader :data_from_scanner, :output_type, :list_name, :time
+    
+    def initialize
+      validate_configuration
+    end
+    
+    def convert hash
+      validate_data_from_scanner hash
+      
+      @data_from_scanner = hash
+      @output_type = Mokuji::configuration['output_type']
+      @list_name = (Mokuji::configuration['list_name'] ||= hash['name'])
+      @time = Time.now.strftime('%d %B %Y (%I:%M%p)')
+      
+      return data = case output_type
+        when 'json' then to_json
+        when 'html' then to_html
+        when 'plain_html' then to_html_plain
+        when 'plain_text' then to_plain_text
+      end
+    end
+    
+    private
+    
+    def to_json
+      require 'json'
+      
+      hash = {
+        'list_name' => list_name,
+        'made_on' => time,
+        'contents' => data_from_scanner.to_json
+      }
+      
+      return hash.to_json
+    end
+    
+    def to_html
+      # Convert the data from the scanner to html
+      html_data = to_html__read_directory data_from_scanner['contents']
+      
+      # Loading some assets
+      assets_path = File.join Mokuji::LIB_PATH, '/mokuji/assets/'
+      
+      minified_jquery = IO.read("#{assets_path}jquery-1.5.min.js")
+      javascript_code = IO.read("#{assets_path}code.js")
+      stylesheet = IO.read("#{assets_path}stylesheet.css")
+      
+      # And push everything into the html template
+      return html_template = %Q{
+        <!doctype html>
+        <html>
+          <head>
+            <meta charset="utf-8">
+            <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+            <title>#{list_name}</title>
+            <style>#{stylesheet}</style>
+          </head>
+          <body>
+            <h1>#{list_name}</h1>
+            <h2>#{time}</h2>
+            <nav>
+              <a id="expand_all">Expand all directories</a> ---
+              <a id="close_all">Close all directories</a>
+            </nav>
+            <ul id="list">#{html_data}</ul>
+          <script>#{minified_jquery}</script>
+          <script>#{javascript_code}</script>
+          </body>
+        </html>
+      }.strip.gsub(/^(\s){8}/, '')
+    end
+    
+    def to_html_plain
+      # Convert the data from the scanner to plain html
+      html_data = to_html__read_directory data_from_scanner['contents']
+      
+      # And push everything into the html template
+      return html_template = %Q{
+        <!doctype html>
+        <html>
+          <head>
+            <meta charset="utf-8">
+            <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+            <title>#{list_name}</title>
+          </head>
+          <body>
+            <h1>#{list_name}</h1>
+            <h2>#{time}</h2>
+            <ul id="list">#{html_data}</ul>
+          </body>
+        </html>
+      }.strip.gsub(/^(\s){8}/, '')
+    end
+    
+    def to_html__read_directory array
+      html = ''
+      
+      array.each do |hash|
+        case hash['type']
+        when 'directory'
+          html << "<li class='directory'><span>#{hash['name']}</span>"
+          html << "<ul>#{to_html__read_directory(hash['contents'])}</ul></li>"
+        when 'file'
+          html << "<li class='file'>#{hash['name']}</li>"
+        end
+      end
+      
+      return html
+    end
+    
+    def to_plain_text
+      # Convert the data from the scanner to plain text
+      return to_plain_text__read_directory '', data_from_scanner['contents']
+    end
+    
+    def to_plain_text__read_directory path, array
+      text = ''
+      
+      array.each do |hash|
+        text << "#{path}#{hash['name']}\n"
+        text << to_plain_text__read_directory("#{path}#{hash['name']}/", hash['contents']) if hash['type'] === 'directory'
+      end
+      
+      return text
+    end
+  end # </Converter>
 
 end