dircat 0.1.12 → 0.2.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2010 tokiro.oyama@gmail.com
+Copyright (c) 2009-2012 tokiro.oyama@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,8 +1,18 @@
-# DIRCAT
+# DIRCAT & Simple Cataloger (merging Simple Cataloger in progress)
 
-Dircat build, starting from a directory, a catalog with files meta information (path, timestamp, md5. ...), so it
-is possible to compare this catalog with another directory to detect duplicate, file change, and so.
-This utilities could be utilized as help to backup a directory or to find duplicates
+## DIRCAT
+
+Dircat build, starting from a directory, a catalog with files
+meta information (path, timestamp, md5. ...), so it is possible to compare
+this catalog with another directory to detect duplicate, file change, and so.
+This utilities could be utilized as help to backup a directory
+or to find duplicates
+
+## Simple Cataloger
+
+An extremely simple cataloging tool. You can use it to index files stored on
+hard disks and create searchable catalogs that can be used without
+having access to original media.
 
 ### dircat build
 
@@ -38,6 +48,21 @@ or
 
 sudo gem install gf-dircat -s gems.github.com
 
-### Copyright
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+## Contributor
+
+2012-08: merging with mstrauss branch (not following symlinks)
+
+## Copyright
 
-Copyright (c) 2009-2010 tokiro.oyama@gmail.com See LICENSE for details.
+Copyright (c) 2009-2012 Tokyro (tokyro.oyama@gmail.com). See LICENSE for details.

data/bin/dircat

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+require 'rubygems'
 cwd = File.expand_path(File.join(File.dirname(__FILE__), %w{ .. lib}))
 $:.unshift(cwd) unless $:.include?(cwd)
 
 require 'dircat'
-DirCat::CliDirCat.run!
+include DirCat
+exit DirCat::CliDirCat.run!
+

data/bin/scat

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+require 'rubygems'
+cwd = File.expand_path(File.join(File.dirname(__FILE__), %w{.. lib}))
+$:.unshift(cwd) unless $:.include?(cwd)
+
+require 'simple_cataloger_cli'
+# TODO: we need exit befor run?
+CliCat.run!

data/dircat.gemspec

@@ -4,14 +4,26 @@ require "dircat/version"
 
 Gem::Specification.new do |gem|
 
-  gem.name = "dircat"
+  gem.name = DirCat::NAME
   gem.version = DirCat::VERSION
   gem.platform = Gem::Platform::RUBY
-  gem.summary = "command line utilities to manage catalogs of directory"
-  gem.description = %Q{
+
+  gem.summary = %Q{
     command line utilities to manage catalogs of directory
+    and damn simple cataloger using directory convention
   }
-  gem.authors = ["Tokiro"]
+
+  gem.description = <<-EOS
+    command line utilities to manage catalogs of directory
+
+    damn simple catalog based on tagging file name.
+    The tag are between bracket.
+    For example the filename 'photo [sea][2010][summer]', associate
+    with the name photo the tag sea,2010,summer.
+  EOS
+
+
+  gem.authors = %w{ Tokiro }
   gem.email = "tokiro.oyama@gmail.com"
   gem.homepage = "http://github.com/tokiro/dircat"
 
@@ -19,39 +31,60 @@ Gem::Specification.new do |gem|
   #
   # dependencies
   #
-  gem.add_runtime_dependency(%q<treevisitor>, ["= 0.2.2"])
-  gem.add_runtime_dependency(%q<optparse-command>, ["= 0.1.6"])
+
+  gem.add_runtime_dependency(%q<tree.rb>)
+  gem.add_runtime_dependency(%q<optparse-command>)
+  gem.add_runtime_dependency(%q<sinatra-group-items>)
+
+  gem.add_runtime_dependency(%q<ansi>, [">= 0"])
+
+  # gem.add_runtime_dependency(%q<data_mapper>, [">= 0"])
+  # gem.add_runtime_dependency(%q<dm-sqlite-adapter>, [">= 0"])
+
+  gem.add_runtime_dependency(%q<activerecord>, [">= 0"])
+  # gem.add_runtime_dependency(%q<mysql2>, ["<= 0.2"])
+  gem.add_runtime_dependency(%q<sqlite3>, [">= 0"])
+
+  gem.add_runtime_dependency(%q<sinatra>, [">= 0"])
+  gem.add_runtime_dependency(%q<haml>, [">= 0"])
+  gem.add_runtime_dependency(%q<sass>, [">= 0"])
+  gem.add_runtime_dependency(%q<json>, [">= 0"])
+
 
   gem.add_development_dependency(%q<rake>, [">= 0"])
   gem.add_development_dependency(%q<yard>, [">= 0"])
   gem.add_development_dependency(%q<bundler>, [">= 0"])
   gem.add_development_dependency(%q<rspec>, [">= 0"])
+  gem.add_development_dependency(%q<webrat>, [">= 0"])
+  gem.add_development_dependency(%q<sinatra>, [">= 0"])
+  gem.add_development_dependency(%q<rmagick>, [">= 0"])
 
   #
   # bin
   #
-  gem.require_paths = ["lib"]
-  gem.executables = %w{ dircat }
   # s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.require_paths = %w{ lib }
+  gem.executables = %w{ dircat scat }
 
   #
   # files
   #
-  gem.files = %w{LICENSE.txt README.md Rakefile dircat.gemspec .gemtest}
-  gem.extra_rdoc_files = [
-      "LICENSE.txt",
-      "README.md"
-  ]
+  # s.files = `git ls-files`.split("\n")
+  gem.files = %w{LICENSE.txt README.md Rakefile dircat.gemspec}
+  gem.extra_rdoc_files = %w{
+      LICENSE.txt
+      README.md
+  }
   gem.files.concat Dir['lib/**/*.rb']
   gem.files.concat Dir['examples/*.rb']
+  gem.files.concat Dir['web/**/*']
   gem.files.concat Dir['tasks/*.rake']
-  # s.files = `git ls-files`.split("\n")
 
   #
   # test files
   #
+  # s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.test_files = Dir['spec/**/*.rb']
   gem.test_files.concat Dir['spec/fixtures/**/*']
-  # s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
 
 end

data/examples/example.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'dircat'
@@ -5,6 +6,6 @@ include DirCat
 
 dir = File.join( File.dirname(__FILE__), "..")
 
-cat  = Cat.from_dir( dir )
+cat  = CatOnYaml.from_dir( dir )
 cat.fmt_report
 

data/lib/dircat.rb

@@ -1,34 +1,29 @@
-# -*- coding: utf-8 -*-
-#
-# std lib
-#
-require 'fileutils'
-require 'tmpdir'
-require 'yaml'
-require 'ostruct'
-require 'optparse'
-require 'pp'
-
-#
-# rubygems
-#
-gem "optparse-command", "0.1.6"
-require 'optparse-command'
-
-gem "treevisitor", "0.2.2"
-require 'treevisitor'
-
-#
-# dircat
-#
-require 'dircat/version'
-require 'dircat/extension_md5'
-require 'dircat/extension_numeric'
-
-require 'dircat/cat'
-require 'dircat/entry'
-
-require 'dircat/cli/cli_dircat'
-require 'dircat/cli/command_build'
-require 'dircat/cli/command_diff'
-require 'dircat/cli/command_query'
+# -*- coding: utf-8 -*-
+#
+# std lib
+#
+require 'fileutils'
+require 'tmpdir'
+require 'yaml'
+require 'ostruct'
+require 'optparse'
+require 'pp'
+
+#
+# rubygems
+#
+require 'optparse-command'
+require 'tree_rb'
+
+#
+# dircat
+#
+require 'dircat/version'
+
+require 'dircat/cat_on_yaml/cat_on_yaml'
+require 'dircat/cat_on_yaml/entry'
+
+require 'dircat/cat_on_yaml_cli/cli_dircat'
+require 'dircat/cat_on_yaml_cli/command_build'
+require 'dircat/cat_on_yaml_cli/command_diff'
+require 'dircat/cat_on_yaml_cli/command_query'

data/lib/dircat/cat_on_sqlite/cat_on_sqlite.rb

@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*-
+module SimpleCataloger
+
+  class CatOnSqlite
+
+    attr_reader :name
+
+    # @param [Object] path
+    def initialize(path, options = {})
+      @verbose ||= options[:verbose]
+      @path = File.expand_path(path)
+      @name = File.basename(path)
+      catalogs_dir = File.dirname(path)
+
+      #
+      # path db, config, etc...
+      #
+      @db_filepath     = File.join(catalogs_dir, "#{name}.sqlite3")
+      @db_log_filepath = File.join(catalogs_dir, "#{name}.log")
+      @config_filepath = File.join(catalogs_dir, "#{name}.yml")
+
+      #TODO: logger usabile per loggare altri eventi oltre a quelli del db
+
+      database_filename = File.join(File.dirname(__FILE__), %w{default_database_config.yml})
+      @active_record_config        = YAML.load(File.open(database_filename))
+      # pp config
+      # ActiveRecord::Base.connection.create_database(catalog_dbname)
+      # ActiveRecord::Base.establish_connection(config['films_mysql'])
+      @active_record_config['films_sqlite']['database'] = @db_filepath
+      @active_record_config                             = @active_record_config['films_sqlite']
+
+      puts "database in '#{@db_filepath}'" if @verbose
+    end
+
+    def open
+      ActiveRecord::Base.establish_connection(@active_record_config)
+      require_models
+      self
+    end
+
+    #
+    # Create a new catalog
+    # @param array of directories
+    #
+    def create(*catalog_roots)
+      fs = [@db_filepath, @db_log_filepath, @config_filepath]
+      fs.each do |f|
+        FileUtils.rm(f) if File.exist?(f)
+      end
+
+      if File.exist? @config_filepath
+        raise SimpleCatalogerError, "cannot create already existent catalog '#{@name}'"
+      end
+      @config = {
+          :roots   => catalog_roots,
+          :ignore  => %w{sub subtitles images},
+          :version => DirCat::VERSION
+      }
+      write_config
+
+      #
+      # migrate db
+      #
+      # TODO: drop tables!
+      ActiveRecord::Base.establish_connection(@active_record_config)
+      ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : false
+      migration_dir = File.join(File.dirname(__FILE__), %w{migration})
+      unless Dir.exist? migration_dir
+        raise "migration dir '#{migration_dir}' not exists"
+      end
+      ActiveRecord::Migrator.migrate(migration_dir, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+      require_models
+    end
+
+    #
+    # Rebuild catalog
+    #
+    def update
+      unless File.exist? @config_filepath
+        raise "cannot update catalog #{@name}"
+      end
+      open
+      read_config
+
+      #
+      # Initialize tag and categories from config
+      #
+      if @config[:categories]
+        # pp @config[:categories]
+        @config[:categories].each_pair do |category, tags|
+          # puts category
+          cat = Category.find_or_create_by_name(category)
+          tags.each do |name|
+            tag          = Tag.find_or_create_by_name(name)
+            tag.category = cat
+            tag.save
+          end
+        end
+      end
+
+      #
+      # read catalog root
+      #
+      @config[:roots].each do |root|
+        dtw = TreeRb::DirTreeWalker.new(root)
+        dtw.ignore /^\./
+        @config[:ignore].each do |i|
+          dtw.ignore i
+        end
+        dtw.visit_file=true
+        dtw.run(DirectoryVisitor.new(root))
+      end
+
+      #
+      # cache rating tag
+      #
+      rating = Category.find_by_name("rating")
+      if rating
+        Item.all.each do |item|
+          t = item.tags.find_by_category_id(rating.id)
+          if t
+            item.rating = t.name.to_i
+            item.save
+          end
+        end
+      end
+    end
+
+    #
+    # array of roots
+    #
+    def roots
+      read_config unless @config
+      @config[:roots]
+    end
+
+    #
+    # update config file with tag category list and association from category to tag name,
+    # so to not lose the association next time the catalog is rebuilt (updated)
+    #
+    def load_categories_in_config
+      h = { }
+      Category.all.each do |category|
+        next if %w{rating year unknown}.include?(category.name)
+        h[category.name] = category.tags.collect { |tag| tag.name }
+      end
+      @config[:categories] = h
+    end
+
+    def write_config
+      File.open(@config_filepath, "w") { |f| f.write @config.to_yaml }
+    end
+
+    private
+
+    def read_config
+      #noinspection RubyResolve
+      @config = YAML.load(File.open(@config_filepath))
+    end
+
+    #
+    # model must be loaded after the connection is established
+    #
+    def require_models
+      model_dir = File.join(File.dirname(__FILE__), %w{ model })
+      unless Dir.exist? model_dir
+        raise "model directory '#{model_dir}' not exists"
+      end
+      Dir[File.join(model_dir, '*.rb')].each do |f|
+        # puts f
+        require f
+      end
+    end
+
+  end # class
+
+end # module SimpleCatalog

data/lib/dircat/cat_on_sqlite/directory_visitor.rb

@@ -0,0 +1,106 @@
+module SimpleCataloger
+
+  #
+  # Find directory without subdirectories
+  #
+  class DirectoryVisitor
+
+    def initialize(catalog_root)
+      @stack        = []
+      @files        = []
+      @nr           = 0
+      @catalog_root = catalog_root
+    end
+
+    def enter_node(pathname)
+      # each directory is associated to a number,
+      # so when exit_tree_node is called and the number @nr is not increased
+      # the directory doesn't have subdirectories
+      @nr += 1
+
+      dirname = File.basename(pathname)
+      tags    = Tag.extract_tags(dirname)
+      tags = tags.concat(@stack.last.tags).uniq unless @stack.empty?
+      info = OpenStruct.new(:nr => @nr, :pathname => pathname, :tags => tags, :name => Tag.extract_name(dirname))
+
+      @files = []
+      @stack.push(info)
+    end
+
+    def exit_node(pathname)
+      info = @stack.pop
+
+      if info.nr == @nr
+        # this directory doesn't have subdirectories
+        name      = info.name
+        tag_names = info.tags
+        puts name
+        # pp tags
+
+        # every name must be unique, two films cannot have the some name
+        if Item.find_by_name(name)
+          raise "item #{name} is not unique path #{pathname}"
+        end
+
+        item = Item.create(
+            :name                   => name,
+            :added_at               => File.lstat(pathname).ctime,
+            :path                   => pathname,
+            :path_from_catalog_root => pathname[File.dirname(@catalog_root).length..-1]
+        )
+
+        #
+        # Associate item and tags
+        #
+        unknown = Category.find_or_create_by_name("unknown")
+        tag_names.each do |tag_name|
+          tag = Tag.find_by_name(tag_name)
+          unless tag
+            tag = Tag.match_category(tag_name)
+            unless tag
+              tag = Tag.find_by_name_and_category_id(tag_name, unknown.id)
+              unless tag
+                tag = Tag.create(:name => tag_name, :category => unknown)
+              end
+            end
+          end
+          Tagging.find_or_create_by_item_id_and_tag_id(item.id, tag.id)
+        end
+
+        #
+        # Searches images
+        #
+        @files.each do |pathname|
+          next unless pathname.match /(jpg|jpeg)$/
+
+          image = Image.find_or_create_by_path_and_path_from_catalog_root(
+              pathname,
+              pathname[File.dirname(@catalog_root).length..-1]
+          )
+          item.images << image
+
+          filename  = File.basename(pathname)
+          tag_names = Tag.extract_tags(filename)
+          tag_names.each do |tag_name|
+            tag = Tag.first(:name => tag_name)
+            if tag
+              tag.images << image
+              tag.save
+            else
+              puts "WARNING: tag '#{tag_name}' not found"
+            end
+          end
+        end
+        item.save
+      end
+    end
+
+
+    #
+    # called when visit leaf node
+    #
+    def visit_leaf(pathname)
+      @files << pathname
+    end
+  end # class
+end # module SimpleCataloger