mokuji 0.2.2 → 1.0.0

data/lib/mokuji/exporter.rb

@@ -1,57 +1,45 @@
-module Mokuji
-
-	#
-	# 	EXPORTER
-	# 	- Exports the data to a file
-	#
+require 'mokuji/validators'
 
-	class Exporter
-	
-	
-	
-		attr_accessor :file_data, :converting_method, :file_name, :export_path
-		
-		
-		
-		def execute
-		
-			# Check
-			fail_msg = "You forgot to set some variables."
-			fail_msg << "Make sure you've set the path to scan and the converting method."
-			
-			raise fail_msg unless file_data || converting_method || export_path
-			
-			# Filename check
-			@file_name = 'Untitled' unless file_name
-			
-			# Export path validation
-			raise "The directory you want to export to doesn't exist" unless File.directory?(export_path)
-			
-			# Set file extension
-			file_extension = case converting_method
-			
-				when :json then '.json'
-				when :html then '.html'
-				
-				else '.txt'
-			
-			end
-			
-			# Change to the directory where the file should be saved
-			Dir.chdir(export_path)
-			
-			# Creating the file
-			File::open( file_name + file_extension, 'w' ) do |f|
-			
-				f << file_data
-			
-			end
-		
-		end
-	
-	
-	
-	end # </Exporter>
+module Mokuji
+  #
+  # { EXPORTER }
+  #
+  # === Info
+  #
+  # Exports the data to a file
+  #
+  # === How to use
+  #
+  # exporter = Mokuji::Exporter.new
+  # exporter.export data_from_converter, export_path
+  
+  class Exporter
+    include Mokuji::Validators
+    
+    def initialize
+      validate_configuration
+    end
+    
+    def export string, path
+      validate_data_from_converter string
+      validate_export_path path
+      
+      data_from_converter = string
+      list_name = (Mokuji::configuration['list_name'] ||= 'Untitled')
+      time = Time.now.strftime('%d_%B_%Y_(%I-%M%p)')
+      file_name = "#{list_name}_-_#{time}"
+      output_type = Mokuji::configuration['output_type']
+      
+      file_extension = case output_type
+        when 'json'                 then 'json'
+        when 'html', 'plain_html'   then 'html'
+        when 'plain_text'           then 'txt'
+      end
+      
+      Dir.chdir(path)
+      
+      File::open("#{file_name}.#{file_extension}", 'w') { |f| f << data_from_converter }
+    end
+  end # </Exporter>
 
 end
-

data/lib/mokuji/scanner.rb

@@ -1,133 +1,85 @@
-module Mokuji
-
-	#
-	# 	SCANNER
-	# 	- Lists the directory contents in an Array (flat) or a Hash (nested)
-	#
-	# 	{ return => Array or Hash }
-	#
+require 'mokuji/validators'
 
-	class Scanner
-	
-	
-	
-		attr_accessor :path_to_scan, :converting_method
-		
-		
-		
-		def execute
-		
-			# Validation
-			raise "You can't scan nil, duh." unless path_to_scan
-			raise "The directory you want to scan doesn't exist" unless File.directory?(path_to_scan)
-			
-			# Go to the directory
-			Dir.chdir(path_to_scan)
-			
-			# Get the data
-			data = case converting_method
-			
-				when :json then FlatArray::make
-				when :html then NestedHashes::make
-				
-				else
-					raise 'The given converting method is unknown'
-			
-			end
-		
-		end
-		
-		
-		
-		protected
-		
-		
-		
-		module FlatArray
-		
-			def self.make
-			
-				# Makes a flat array
-				array = Dir.glob('**/**')
-				array.sort!
-			
-			end
-		
-		end
-		
-		
-		
-		module NestedHashes
-		
-			def self.make
-			
-				# Directory (name)
-				path = Dir.pwd
-				path.chomp!('/')
-				
-				rindex = path.rindex('/') + 1
-				directory_name = path.slice(rindex..-1)
-				
-				# Makes a hash with hashes in it
-				NestedHashes::read_directory path, directory_name
-			
-			end
-			
-			def self.read_directory path, directory_name
-			
-				# Set
-				hash = {
-				
-					'type' => 'directory',
-					'name' => directory_name,
-					'contents' => []
-				
-				}
-				
-				# Open the directory
-				d = Dir.entries(path)
-				
-				# Sort it
-				d.sort!
-				
-				# Going over each file and directory
-				for x in d
-				
-					# Hide certain files/directories
-					if x == '.' || x == '..' || x.slice(0) == '.' then; next; end
-					
-					# Stuff
-					x_path = path + '/' + x
-					
-					if File.directory? x_path then
-					
-						hash['contents'] << NestedHashes::read_directory(x_path, x)
-					
-					else
-					
-						new_file_hash = {
-							
-							'type' => 'file',
-							'name' => x
-						
-						}
-						
-						hash['contents'] << new_file_hash
-					
-					end
-				
-				end
-				
-				# Return
-				return hash
-			
-			end
-		
-		end
-	
-	
-	
-	end # </Scanner>
+module Mokuji
+  #
+  # { SCANNER }
+  #
+  # ==== Info
+  #
+  # Lists the directory contents in nested hashes / arrays
+  # Dot files are hidden by default
+  #
+  # ==== Output example : Hash
+  #
+  # example = {
+  #  type: 'directory'
+  #  name: 'I am an example'
+  #  contents: [ directory_hash, file_hash, file_hash ]
+  # }
+  #
+  # ==== How to use
+  #
+  # scanner           =   Mokuji::Scanner.new
+  # scanner_results   =   scanner.scan '/usr/local/Cellar/'
+  
+  class Scanner
+    include Mokuji::Validators
+    
+    attr_reader :path_to_scan
+    
+    def initialize
+      validate_configuration
+    end
+    
+    def scan path
+      validate_import_path path
+      @path_to_scan = path
+      return make_collection
+    end
+    
+    private
+    
+    def make_collection
+      directory_name = File.basename(@path_to_scan)
+      return read_directory(@path_to_scan, directory_name)
+    end
+      
+    def read_directory path, directory_name
+      # Create new hash
+      hash = {
+        'type' => 'directory',
+        'name' => directory_name,
+        'contents' => []
+      }
+      
+      # Going over each file and directory
+      d = Dir.entries(path).sort
+      
+      # Keep certain files/directories out of the list
+      ['.', '..', '.DS_Store', 'Thumbs.db'].each { |str| d.delete str }
+      
+      # Optional
+      d.delete_if { |x| x[0] === '.' } unless Mokuji::configuration['show_dot_files']
+      
+      # Loop over each item
+      d.each do |x|
+        x_path = path + '/' + x
+        
+        if File.directory? x_path
+          hash['contents'] << read_directory(x_path, x)
+        else
+          new_file_hash = {
+            'type' => 'file',
+            'name' => x
+          }
+          
+          hash['contents'] << new_file_hash
+        end
+      end
+      
+      # Return
+      return hash
+    end
+  end # </Scanner>
 
 end
-

data/lib/mokuji/validators.rb

@@ -0,0 +1,67 @@
+module Mokuji
+  #
+  # { VALIDATORS }
+  
+  module Validators
+    def self.validate_options hash
+      if hash['output_type']
+        unless ['json', 'html', 'plain_html', 'plain_text'].include? hash['output_type']
+          raise "Sorry, but, this output type is unknown."
+        end
+      end
+    end
+    
+    def validate_configuration
+      unless Mokuji.method_defined? :configuration
+        begin
+          require 'mokuji'
+        rescue LoadError
+          raise "What have you done with this gem? 'mokuji.rb' is missing!"
+        end
+      end
+    end
+    
+    def validate_import_path path
+      case
+      when !File.directory?(path)
+        raise "Arr, that directory you want to scan, it doesn't quite exist."
+      when Dir.entries(path).slice(2..-1).empty?
+        raise "Arr, that directory you want to scan, it's empty."
+      end
+    end
+    
+    def validate_export_path path
+      case
+      when !File.directory?(path)
+        raise "Arr, that directory you want to export to, it doesn't quite exist."
+      end
+    end
+    
+    def validate_data_from_scanner hash
+      case
+      when hash.class ==! Hash
+        raise "Wait a minute, this isn't a hash!"
+      when hash.empty?
+        raise "This hash is empty. Lame!"
+      end
+    end
+    
+    def validate_data_from_converter string
+      case
+      when string.class ==! String
+        raise "Wait a minute, this isn't a string!"
+      when string.length === 0
+        raise "The length of this string is zero. Lame!"
+      end
+    end
+    
+    def json_valid? str
+      begin
+        JSON.parse str
+        return true
+      rescue JSON::ParserError
+        return false
+      end
+    end
+  end # </Validators>
+end

data/lib/mokuji/version.rb

@@ -1,10 +1,6 @@
 module Mokuji
+  #
+  # { VERSION }
 
-	#
-	# 	MOKUJI VERSION
-	#
-
-	VERSION = "0.2.2"
-
+  VERSION = "1.0.0"
 end
-

data/spec/converter_spec.rb

@@ -1,63 +1,35 @@
 require 'mokuji/converter'
 
-
 describe 'Converter' do
-
-
-	before do
-	
-		converter = Mokuji::Converter.new
-		converter.time = Time.now.strftime('%d %B %Y (%I:%M%p)')
-		converter.data_from_scanner = ['immafile.rb']
-		converter.converting_method = :json
-		@dfc_json = converter.execute
-		
-		test_hash = {
-		
-			'type' => 'directory',
-			'name' => 'Icid',
-		'contents' => [ {'type' => 'file', 'name' => 'immafile.rb'} ]
-		
-		}
-		
-		converter.data_from_scanner = test_hash
-		converter.converting_method = :html
-		@dfc_html = converter.execute
-	
-	end
-	
-	
-	# JSON
-	it do
-	
-		@dfc_json.should be_an_instance_of String
-	
-	end
-	
-	
-	it do
-	
-		# Parse the JSON that was just created
-		# and see if it fits
-		j = JSON.parse @dfc_json
-		j['contents'].to_a.should be_an_instance_of Array
-	
-	end
-	
-	
-	# HTML
-	it do
-	
-		@dfc_html.should be_an_instance_of String
-	
-	end
-	
-	
-	it do
-	
-		@dfc_html.should include '<html'
-	
-	end
-
-
+  before do
+    @converter = Mokuji::Converter.new
+    
+    @test_data = {
+      'type' => 'directory',
+      'name' => 'Icid',
+      'contents' => [ {'type' => 'file', 'name' => 'file.txt'} ]
+    }
+  end
+  
+  it "should include the validators module" do
+    @converter.methods.should include :validate_configuration
+  end
+  
+  # HTML
+  it do
+    Mokuji.configure 'output_type' => 'html'
+    @df_html = @converter.convert @test_data
+    
+    @df_html.should be_an_instance_of String
+    @df_html.should include '<html'
+  end
+  
+  # JSON
+  it do
+    Mokuji.configure 'output_type' => 'json'
+    @df_json = @converter.convert @test_data
+    
+    @df_json.should be_an_instance_of String
+    @converter.json_valid?(@df_json).should be true
+  end
 end