biblioteque 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+# http://www.gnu.org/software/automake
+
+Makefile.in
+
+# http://www.gnu.org/software/autoconf
+
+/autom4te.cache
+/aclocal.m4
+/compile
+/configure
+/depcomp
+/install-sh
+/missing
+
+doc
+.yardoc
+Gemfile.lock
+/pkg

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in biblioteque.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Eremin Andrey
+
+MIT License
+
+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.md

@@ -0,0 +1,68 @@
+# Biblioteque
+
+Biblioteque is a little gem that provides all necessary methods to create  databases of files stored in local directories.
+
+## Usage example
+
+    require 'biblioteque'
+    engine = Biblioteque::Engine.new
+
+Now we can create a new database:
+
+    engine.create_db("<DBname>", "<PathToDatabaseFile>")
+
+then we need to load created db:
+
+    db = engine.load_db("<PathToDatabaseFile>")
+
+Let's add a new library:
+
+    db.create_library("<LibraryName>")
+
+and load it:
+
+    library = db.libraries.first
+
+and import files information into it:
+
+    library.add("<PathToCrawlForFiles>")
+
+Now, we can search for added files in a library:
+
+    library.search('<FileNameOrPatternToSearch>')
+
+or in entiry database:
+
+    db.search('<FileNameOrPatternToSearch>')
+
+Oh! and do not forget to save all the changes:
+
+    db.save
+
+
+## Dependencies
+
+This project doesn't have any runtime dependencies, only Ruby 1.9.3+.
+During development, the dependencies are: redcarpet, yard, mocha.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'biblioteque'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install biblioteque
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/*_test.rb'
+  t.verbose = false
+end
+
+task :default => 'test'

data/biblioteque.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "biblioteque/version"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Eremin Andrey"]
+  gem.email         = ["dsoft88@gmail.com"]
+  gem.description   = %q{Local files parser. It parses files stored in a local directories and writes the information into db in JSON format.}
+  gem.summary       = %q{Local files parser. It parses files stored in a local directories and writes the information into db in JSON format.}
+  gem.homepage      = "http://eremin.me"
+
+  gem.rubyforge_project = "biblioteque"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "biblioteque"
+  gem.require_paths = ["lib"]
+  gem.version       = Biblioteque::VERSION
+
+  gem.add_development_dependency "yard" 
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "mocha" 
+  gem.add_development_dependency "redcarpet" 
+end

data/lib/biblioteque.rb

@@ -0,0 +1,19 @@
+require "biblioteque/version"
+
+module Biblioteque
+ 
+  require 'json'
+  require 'securerandom'
+  require 'fileutils'  
+  require 'pathname'
+  require 'find'
+  require 'fileutils'
+
+  require "biblioteque/model"
+  require "biblioteque/library"
+  require "biblioteque/database"
+
+  require "biblioteque/engine"
+  require "biblioteque/crawler"
+  
+end

data/lib/biblioteque/crawler.rb

@@ -0,0 +1,44 @@
+module Biblioteque
+	class Crawler
+
+		def initialize(path)
+			raise "No" unless path
+			@path = path
+		end
+
+		def search_for_library(library_id)
+			arr = []
+			Find.find(@path) do |path|
+			  if FileTest.directory?(path)
+			    if File.basename(path)[0] == ?. and File.basename(path) != '.'
+			      Find.prune
+			    else
+			      arr << make_file_obj(path, library_id) if path != @path # add directory
+			    end
+			  else
+			    arr << make_file_obj(path, library_id) # add file
+			  end
+			end	
+			return arr	
+		end
+
+		private
+
+		def make_file_obj(path, library_id)
+			obj = File.stat(path)
+			{
+			  id:Model.generate_id, library_id:library_id, 
+		      created_at:obj.ctime, updated_at:obj.mtime,
+		      file:File::file?(path), name:filename(path), path:filepath(path)
+		    }
+		end	
+
+		def filename(path)
+			File.basename(path)
+		end
+
+		def filepath(path)
+			File.dirname(path.gsub(@path,""))
+		end
+	end
+end

data/lib/biblioteque/database.rb

@@ -0,0 +1,113 @@
+module Biblioteque
+	class Database < Model
+		attr_accessor :path, :updated_at
+
+		def self.create(name, path)
+			raise "No" unless name || path
+			new_db = {id:generate_id,name:name,created_at:Time.now,updated_at:Time.now}
+			File.open(path,"w+") do |f|
+			  f.write(new_db.to_json)
+			end
+			true
+		end
+
+		def self.clone(path_source, path_destination)
+			raise "No" unless path_source || path_destination
+			FileUtils.cp(path_source, path_destination)
+			true
+		end
+
+		def self.destroy(path_source)
+			File.delete(path_source) ? true : false
+		end
+
+		def initialize(params = {})
+			super
+			@libraries = []
+			@dbpath = params[:path]
+			@loaded = false
+			@library = nil
+			@to_hash_params = [:id, :name, :updated_at, :created_at]
+		end
+
+		def create_library(name)
+			raise "No" unless name
+			lib = Library.create(name, self.id)
+			@libraries << lib
+			lib
+		end
+
+		def load_library(library_id)
+			@libraries.each do |lib|
+				if lib.id == library_id
+					@library = lib
+					return lib
+				end
+			end	
+			nil
+		end
+
+		def close_library
+			@library = nil
+		end
+
+		def current_library
+			@library
+		end
+
+		def libraries
+			@libraries
+		end
+
+		def load
+			json = File.read(@dbpath)
+			db = JSON.parse(json)
+			self.id = db["id"]
+			self.name = db["name"]
+			self.path = @dbpath
+			self.created_at = db["created_at"]
+			self.updated_at = db["updated_at"]
+			load_libraries(db["libraries"])
+			@loaded = true
+		end	
+
+		def status
+			@loaded ? "Loaded" : "Not Loaded"
+		end	
+
+		def save
+			db = self.to_hash
+			db[:libraries] = []
+			libraries.each{|l| db[:libraries] << l.to_hash }
+			save_to_file(@dbpath ,db.to_json)
+		end
+
+		def search(filter)
+			results = []
+			libraries.each do |l|
+				results << {library:l.id,results:l.search(filter)}
+			end
+			results
+		end
+
+		def delete_library(id)
+			return false unless id.to_i
+			libraries.delete_if{|l| l.id == id }
+			true
+		end
+
+		private 
+
+		def load_libraries(libraries_arr)
+			return false unless libraries_arr
+			libraries_arr.each do |library|
+				lib = Library.new(id:library[:id],name:library[:id],
+					db_id:library[:db_id],created_at:library[:created_at],
+					updated_at:library[:updated_at])
+				lib.items = library[:items]
+				@libraries << lib
+			end
+			true
+		end	
+	end
+end

data/lib/biblioteque/engine.rb

@@ -0,0 +1,48 @@
+module Biblioteque
+	class Engine
+
+		def initialize
+			@dbpath = nil
+			@db = nil
+		end
+
+		def current_db
+			@db
+		end
+
+		def current_db_path
+			@dbpath
+		end
+
+		def load_db(path)
+			@dbpath = path
+			@db = Database.new(path:path)
+			@db.load
+			@db
+		end
+
+		def create_db(name, path)
+			Database.create(name, path)
+		end
+
+		def clone_db(path_source, path_destination)
+			Database.clone(path_source, path_destination)
+		end
+
+		def close_db
+			@dbpath = nil
+			@db = nil
+		end
+
+		def delete_db
+			dbpath = current_db_path
+			close_db
+			Database.destroy(dbpath)			
+		end	
+
+		def clone_current(path_destination)
+			return false unless current_db_path
+			Database.clone(current_db_path, path_destination)
+		end		
+	end
+end

data/lib/biblioteque/library.rb

@@ -0,0 +1,60 @@
+module Biblioteque
+	class Library < Model
+		attr_accessor :updated_at, :db_id
+
+		def self.create(name, db_id)
+			raise "No" unless name
+			lib = self.new
+			lib.id = generate_id
+			lib.name = name
+			lib.db_id = db_id
+			lib.created_at = Time.now
+			lib.updated_at = Time.now
+			lib
+		end
+
+		def initialize(params = {})
+			super
+			@items = []
+			@to_hash_params = [:id, :name, :updated_at, :created_at, :db_id, :items]
+		end	
+
+		def items
+			@items
+		end
+
+		def stat
+			puts "#Library #{name} status#"
+			puts " created at: #{created_at}"
+			puts " updated at: #{updated_at}"
+			puts " items: #{self.items.size}"
+			puts " folders: #{folders.size}"
+			puts " files: #{files.size}"
+		end 
+
+		def folders
+			@items.select{|i| i[:file] == false}
+		end
+
+		def files
+			@items.select{|i| i[:file] == true}
+		end
+
+		def add(path)   
+			raise "No" unless path
+			crawler = Crawler.new(path)
+			@items = @items | crawler.search_for_library(id)
+			true
+		end
+
+		def search(filter)
+			return nil unless filter
+			filter.downcase!
+			items.select do |i|
+				i[:path].downcase.index(filter) || 
+				i[:name].downcase.index(filter) ||
+				i[:id] == filter
+			end
+		end
+	end
+end

data/lib/biblioteque/model.rb

@@ -0,0 +1,33 @@
+module Biblioteque
+	class Model
+		attr_accessor :id, :name, :created_at	
+
+		def initialize(params = {})
+	    	params.each do |attr, value|
+	      		self.public_send("#{attr}=", value) if self.respond_to? "#{attr}="
+	    	end if params
+		end
+
+		def save_to_file(path, data = {})
+			File.open(path,"w+") do |f|
+			  f.write(data.to_json)
+			end
+			true
+		end
+
+		def to_hash
+			hash = {}
+			return hash unless @to_hash_params
+		    @to_hash_params.each {|var| hash[var] = instance_variable_get("@#{var.to_s}") }
+			hash
+		end
+
+	    def search(filter)
+	    	raise "Not availalable for parent class"
+	    end		
+
+		def self.generate_id
+			SecureRandom.hex 
+	    end	
+	end
+end

data/lib/biblioteque/version.rb

@@ -0,0 +1,3 @@
+module Biblioteque
+  VERSION = "0.0.1"
+end

data/test/creation_test.rb

@@ -0,0 +1,33 @@
+$:.unshift File.dirname(__FILE__)
+require 'test_helper'
+include TestFileOperations
+
+describe 'Engine' do
+	describe 'create an empty database' do
+		let(:engine){setup_test_engine}
+		it "should create an empty database" do
+			status = engine.create_db("TestDB", "test_path/testdb.ml")
+			status.must_equal true
+    end
+
+  	it "should load created db" do
+  		db = engine.load_db("test_path/testdb.ml")
+  		db.id.must_equal("3423dfgs322dd")
+  		db.name.must_equal("testname")
+  		db.status.must_equal("Loaded")
+  	end
+
+  	it "should save created db" do
+  		db = engine.load_db("test_path/testdb.ml")
+  		db.save.must_equal true 
+  	end
+
+    it "should close loaded db" do
+  		db = engine.load_db("test_path/testdb.ml")
+  		db.wont_be_nil
+  		engine.current_db.wont_be_nil
+  		engine.close_db
+  		engine.current_db.must_be_nil
+    end      	
+	end
+end

data/test/library_test.rb

@@ -0,0 +1,31 @@
+$:.unshift File.dirname(__FILE__)
+require 'test_helper'
+include TestFileOperations
+
+describe 'Engine' do
+	describe 'work with library in a database' do
+		let(:engine){setup_test_engine}
+    before(:each) do
+      @db = engine.load_db("test_path/testdb.ml")
+      @db.create_library("TestLibrary")
+    end
+
+  	it "should create a new library in a loaded db" do
+  		@db.id.must_equal("3423dfgs322dd")
+      @db.libraries.size.must_equal 1
+      @db.libraries.first.id.wont_be_nil
+  	end
+
+    it "should add files to a loaded library" do
+      library = @db.libraries.first
+      library.add("test_crawler_path/")
+      library.files.size.must_equal 1
+    end     
+
+  	it "should delete created library from a loaded db" do
+      status = @db.delete_library(@db.libraries.first.id)
+  	  status.must_equal true
+      @db.libraries.size.must_equal 0
+  	end 
+	end
+end

data/test/operation_test.rb

@@ -0,0 +1,28 @@
+$:.unshift File.dirname(__FILE__)
+require 'test_helper'
+include TestFileOperations
+
+describe 'Engine' do
+	describe 'do some actions on a database' do
+      	let(:engine){setup_test_engine}
+      	it "should clone a database" do
+      		status = engine.create_db("TestDB", "test_path/testdb.ml")
+      		status.must_equal true
+                  status = engine.clone_db("test_path/testdb2.ml", "test_path/testdb.ml")
+                  status.must_equal true
+      	end
+      	
+      	it "should delete created db" do
+      		db = engine.load_db("test_path/testdb.ml")
+                  status = engine.delete_db
+      		status.must_equal true
+                  engine.current_db.must_be_nil
+      	end
+
+            it "should delete db by using db method" do
+                  File.stubs(:delete).returns(1)
+                  status = Biblioteque::Database.destroy("test_path/testdb.ml")
+                  status.must_equal true
+            end
+	end
+end

data/test/search_test.rb

@@ -0,0 +1,29 @@
+$:.unshift File.dirname(__FILE__)
+require 'test_helper'
+include TestFileOperations
+
+describe 'Engine' do
+	describe 'search for file' do
+		let(:engine){setup_test_engine}
+    before(:each) do
+      @db = engine.load_db("test_path/testdb.ml")
+      @db.create_library("TestLibrary")
+      @library = @db.libraries.first
+      @library.add("test_crawler_path/")
+    end
+
+		it "should search entire database for '.txt' file" do
+      results = @db.search('.txt')
+      results.size.must_equal 1
+      results[0][:library].must_equal @library.id
+      results[0][:results].size.must_equal 1
+      results[0][:results][0][:id].must_equal @library.files.first[:id]
+    end
+
+  	it "should search a library for 'path' file" do
+  		results = @library.search('path')
+      results.size.must_equal 1
+      results[0][:id].must_equal @library.files.first[:id]
+  	end     	
+	end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha'
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'biblioteque'
+
+module TestFileOperations
+  def setup_test_engine
+    #Stubs IO operations for testing purposes
+    File.stubs(:open).returns(true)
+    File.stubs(:read).returns({id:"3423dfgs322dd",name:"testname",created_at:Time.now,updated_at:Time.now}.to_json)
+    File.stubs(:file?).returns(true)
+    File.stubs(:delete).returns(1)
+    File.stubs(:stat).returns(File::Stat.new("test"))
+    FileUtils.stubs(:cp).returns(true)
+    FileTest.stubs(:directory?).returns(false)
+    Find.stubs(:find).yields("/test_crawler_path/test/path.txt")
+    #
+    Biblioteque::Engine.new
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: biblioteque
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eremin Andrey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Local files parser. It parses files stored in a local directories and
+  writes the information into db in JSON format.
+email:
+- dsoft88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- biblioteque.gemspec
+- lib/biblioteque.rb
+- lib/biblioteque/crawler.rb
+- lib/biblioteque/database.rb
+- lib/biblioteque/engine.rb
+- lib/biblioteque/library.rb
+- lib/biblioteque/model.rb
+- lib/biblioteque/version.rb
+- test/creation_test.rb
+- test/library_test.rb
+- test/operation_test.rb
+- test/search_test.rb
+- test/test_helper.rb
+homepage: http://eremin.me
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: biblioteque
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Local files parser. It parses files stored in a local directories and writes
+  the information into db in JSON format.
+test_files:
+- test/creation_test.rb
+- test/library_test.rb
+- test/operation_test.rb
+- test/search_test.rb
+- test/test_helper.rb