luigi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31f72e1bb7c69d75d612950916f95e58fa4400aa
+  data.tar.gz: 5ef3d3525cc4fed1a18e116f2a181b0404345824
+SHA512:
+  metadata.gz: 36b695ae7932032f603148293248e81783306009f32fcf88aa9c0bc151987cb84cfb635114e8b5fb4129d55b920c3beb97543f5a14139770dc4803bbfea22073
+  data.tar.gz: 5a90dce275ef2342a929b19c05387d581f5b51e171e336efc2c9ff7e7c386bfbaed2106b3a6a4ef7602935d58924ae693035a4f0f87027335389e7da6ae5fb5f

data/lib/PlumberProject.rb

@@ -0,0 +1,34 @@
+require 'date'
+
+#interface
+class PlumberProject
+
+  def initialize path
+    open path
+  end
+
+  def open path
+    @path = path
+  end
+
+  def path
+    @path
+  end
+
+  def name
+    File.basename @path, ".yml"
+  end
+
+  def index
+    123
+  end
+
+  def STATUS
+    :ok # at least :ok or anything else
+  end
+
+  def date
+    return Date.today
+
+  end
+end

data/lib/luigi.rb

@@ -0,0 +1,396 @@
+# encoding: utf-8
+require 'fileutils'
+require 'logger'
+
+require File.join File.dirname(__FILE__), "luigi/gitplumber"
+require File.join File.dirname(__FILE__), "luigi/ShellSanitizer"
+
+## requires a project_class
+# project_class must implement: name, date
+class Luigi
+
+  attr_reader :dirs,
+    :opened_projects,
+    :project_paths,
+    :opened_paths,
+    :opened_sort,
+    :opened_dir
+
+  attr_writer :project_class
+
+  include GitPlumber
+
+
+  def initialize(settings, project_class = nil)
+    @settings        = settings
+    @opened_projects = []
+    @project_class   = project_class
+    @file_extension  = settings['project_file_extension']
+    @using_git       = settings['use_git']
+
+    @logger = Logger.new(STDERR)
+    @logger.level = Logger::ERROR
+    @logger.error "need a project_class" if project_class.nil?
+    @logger.progname = "LUIGI"
+
+    @dirs            = {}
+    # TODO allow for multiple templates
+    @dirs[:template] = File.expand_path File.join @settings['script_path'], @settings['templates']['project']
+    @dirs[:storage]  = File.expand_path File.join @settings['path'], @settings['dirs']['storage']
+    @dirs[:working]  = File.join @dirs[:storage], @settings['dirs']['working']
+    @dirs[:archive]  = File.join @dirs[:storage], @settings['dirs']['archive']
+
+
+  end
+
+  ##
+  # Checks the existens of one of the three basic dirs.
+  # dir can be either :storage, :working or :archive
+  # and also :template
+  def check_dir(dir)
+    File.exists? "#{@dirs[dir]}"
+  end
+
+  ##
+  # Checks the existens of every thing required
+  def check_dirs
+    check_dir :storage and
+    check_dir :working and
+    check_dir :archive and
+    check_dir :template
+  end
+
+  ##
+  # create a dir
+  # dir can be either :storage, :working or :archive
+  def create_dir(dir)
+    unless check_dir(dir)
+      if dir == :storage or check_dir :storage
+        FileUtils.mkdir "#{@dirs[dir]}"
+        @logger.info "Created \"#{dir.to_s}\" Directory (#{@dirs[dir]})"
+        return true
+      end
+      @logger.error "no storage dir"
+    end
+    return false
+  end
+ 
+  ##
+  # creates new project_dir and project_file
+  def _new_project_folder(name)
+    unless check_dir(:working)
+      @logger.info(File.exists? @dirs[:working])
+      @logger.info "missing working directory!"
+      return false
+    end
+
+    #  check of existing project with the same name
+    folder = get_project_folder(name, :working)
+    unless folder
+      FileUtils.mkdir File.join @dirs[:working], name
+      return get_project_folder(name, :working)
+    else
+      @logger.info "#{folder} already exists"
+      return false
+    end
+  end
+
+  ##
+  # creates new project_dir and project_file
+  # returns project object
+  def new_project(_name)
+    _name = ShellSanitizer.process _name
+    name = ShellSanitizer.clean_path _name
+
+    project_name   = _name
+    settings       = @settings
+    defaults       = @settings['defaults']
+    defaults       = {}
+
+    filename = @dirs[:template]
+
+    ## Approach A ( Thomas Kühn )
+    engine=ERB.new(File.read(filename),nil,'<>')
+    result = engine.result(binding)
+
+    # copy template_file to project_dir
+    folder = _new_project_folder(name)
+    if folder
+      target = File.join folder, name+@file_extension
+
+      #puts "writing into #{target}"
+      file = File.new target, "w"
+      result.lines.each do |line|
+        file.write line
+      end
+      file.close
+
+      @logger.info "#{folder} created"
+      return @project_class.new target
+    else
+      return false
+    end
+  end
+
+
+  ##
+  # produces an Array of @project_class objects
+  # sorted by date (projects must implement date())
+  # if sort is foobar, projects must implement foobar()
+  # output of (foobar must be comparable)
+  #
+  # untested
+  def open_projects(dir=:working, year=Date.today.year, sort = :date)
+    if dir==:all
+      @opened_paths    = list_projects_all
+    else
+      @opened_paths    = list_projects dir, year 
+    end
+
+    @opened_dir      = dir
+    @project_paths   = {}
+    @opened_paths.each {|path|
+      project = @project_class.new path
+      if project.STATUS == :ok
+        @opened_projects = @opened_projects + [ project ]
+      end
+      @project_paths[project.name] = path
+    }
+    sort_projects(sort)
+    return true
+  end
+
+  def open_project project
+    if project.class == String
+      project = ShellSanitizer.process    project
+      project = ShellSanitizer.clean_path project
+      open_projects()
+      project = lookup(project)
+    end
+    return project if project.class == @project_class
+    return false
+  end
+
+
+  ##
+  # produces an Array of @project_class objects
+  #
+  # untested
+  def open_projects_all(sort = :date)
+    @opened_paths    = list_projects_all
+    open_projects :all, year=nil, sort
+  end
+
+  def [] name
+    lookup name
+  end
+
+  def lookup_path(name, sort = nil)
+    p = lookup(name)
+    return @project_paths[p.name] unless p.nil?
+    @logger.error "there is no project #{name}"
+    return false
+  end
+  
+  
+  def lookup(name, sort = nil)
+    sort_projects sort unless sort == nil or @opened_sort == sort
+    name = name.to_i - 1 if name =~ /^\d*$/
+    if name.class == String
+      name_map = {}
+      @opened_projects.each {|project| name_map[project.name] = project}
+      project = name_map[name]
+      @logger.error "there is no project \"#{name}\"" if project.nil?
+    elsif name.class == Fixnum
+      project =  @opened_projects[name]
+      @logger.error "there is no project ##{name+1}" if project.nil?
+    end
+    return project
+  end
+  
+  
+  def sort_projects(sort = :date)
+      fail "sort must be a Symbol" unless sort.class == Symbol
+      if @project_class.method_defined? sort
+          @opened_projects.sort_by! {|project| project.method(sort).call}
+      else fail "#{@project_class} does not implement #{sort}()"
+      end
+      return true
+  end
+  
+  ##
+  # path to project file
+  # there may only be one @file_extension file per project folder
+  #
+  # untested
+  def get_project_file_path(name, dir=:working, year=Date.today.year)
+      name = ShellSanitizer.process    name
+      name = ShellSanitizer.clean_path name
+      
+    folder = get_project_folder(name, dir, year)
+    if folder
+      files = Dir.glob File.join folder, "*#{@file_extension}"
+      warn "ambiguous amount of #{@file_extension} files in #{folder}" if files.length > 1
+      warn "no #{@file_extension} files in #{folder}" if files.length < 1
+      return files[0]
+    end
+    @logger.info "NO FOLDER get_project_folder(name = #{name}, dir = #{dir}, year = #{year})"
+    return false
+  end
+
+
+  ##
+  # Path to project folder
+  # If the folder exists
+  # dir can be :working or :archive 
+  #
+  # TODO untested for archives
+  def get_project_folder( name, dir=:working, year=Date.today.year )
+    name = ShellSanitizer.process    name
+    name = ShellSanitizer.clean_path name
+    year = year.to_s
+    target = File.join @dirs[dir], name       if dir == :working
+    target = File.join @dirs[dir], year, name if dir == :archive
+    return target if File.exists? target
+    false
+  end
+
+  ##
+  # list projects
+  # lists project files
+  def list_project_names(dir = :working, year=Date.today.year)
+    return unless check_dir(dir)
+    if dir == :working
+      paths = Dir.glob File.join @dirs[dir], "/*"
+      names = paths.map {|path| File.basename path }
+    elsif dir == :archive
+      paths = Dir.glob File.join @dirs[dir], year.to_s, "/*"
+      names = paths.map {|path|
+        file_path = get_project_file_path (File.basename path), :archive, year
+        name = File.basename file_path, @file_extension
+      }
+      return names
+    else
+      @logger.error "unknown path #{dir}"
+    end
+  end
+
+  ##
+  # list projects
+  # lists project files
+  # (names actually contains paths)
+  def list_projects(dir = :working, year=Date.today.year)
+    return unless check_dir(dir)
+    if dir == :working
+      folders = Dir.glob File.join @dirs[dir], "/*"
+      paths = folders.map {|path| get_project_file_path File.basename path }
+    elsif dir == :archive
+      folders = Dir.glob File.join @dirs[dir], year.to_s, "/*"
+      paths = folders.map {|path| get_project_file_path (File.basename path), :archive, year }
+    else
+      @logger.error "unknown path #{dir}"
+    end
+
+    puts "WARNING! one folder is not correct" if paths.include? false
+    paths.keep_if{|v| v}
+  end
+
+  ##
+  # list projects
+  # lists project files
+  # (names actually contains paths)
+  def list_projects_all
+    names = []
+
+    #first all archived projects, ever :D
+    archives = Dir.glob File.join @dirs[:archive], "/*"
+    archives.sort!
+    archives.each do |a|
+      paths = Dir.glob File.join a, "/*"
+      year = File.basename a
+      names += paths.map { |path|
+        get_project_file_path (File.basename path), :archive, year
+      }
+    end
+
+    #then all working projects
+    names += list_projects :working
+
+    return names
+  end
+
+  def filter_by hash
+    filtered_projets = []
+    @opened_projects.each{|project|
+      hash.each{|key,value|
+        field = project.data(key)
+        if field and field.to_s.downcase.include? value
+          filtered_projets.push project
+          break
+        end
+      }
+    }
+    return filtered_projets
+  end
+
+  ##
+  #  Move to archive directory
+  #  @name 
+  ## Luigi.archive_project should use ShellSanitizer
+  def archive_project(project, year = nil, prefix = '')
+    project = open_project project
+    return false unless project.class == @project_class
+    
+    year ||= project.date.year
+    year_folder = File.join @dirs[:archive], year.to_s
+    FileUtils.mkdir year_folder unless File.exists? year_folder
+
+    project_folder = get_project_folder project.name, :working
+    if prefix and prefix.length > 0
+      archived_name = project.name.prepend(prefix + "_")
+      target = File.join year_folder, archived_name
+    else
+      target = File.join year_folder, project.name
+    end
+
+    return false unless project_folder
+    return false if list_project_names(:archive, year).include? project.name
+
+    @logger.info "moving: #{project_folder} to #{target}" if target and project_folder
+
+    FileUtils.mv project_folder, target
+    if open_git()
+      git_update_path project_folder
+      git_update_path target
+    end
+    return target
+  end
+
+  ##
+  #  Move to archive directory
+  def unarchive_project(project, year = Date.today.year)
+    project = open_project project
+    return false unless project.class == @project_class
+
+    name         = project.name
+    path         = project.path
+    cleaned_name = File.basename(path,@file_extension)
+    source       = get_project_folder name, :archive, year
+    target       = File.join @dirs[:working], cleaned_name
+
+    @logger.info "moving #{source} to #{target}"
+    return false unless source
+
+    unless get_project_folder cleaned_name
+      FileUtils.mv source, target
+      if open_git()
+        git_update_path source
+        git_update_path target
+      end
+      return true
+    else
+      return false
+    end
+  end
+
+end

data/lib/luigi/ShellSanitizer.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+class ShellSanitizer 
+  REPLACE_HASH = {
+    ?“ => '"', ?” => '"', ?‘ => "'", ?’ => "'", ?„ => '"',
+
+    ?» => ">>", ?«  => "<<",
+    ?ä => "ae", ?ö  => "oe", ?ü   => "ue",
+    ?Ä => "Ae", ?Ö  => "Oe", ?Ü   => "Ue",
+    ?ß => "ss", ?ï  => "i",  ?ë   => "e",
+    ?æ => "ae", ?Æ  => "AE", ?œ   => "oe",
+    ?Π=> "OE",
+    ?€ => "EUR", ?¥ => "YEN",
+    ?½ => "1/2", ?¼ => "1/4", ?¾  => "3/4",
+    ?© => "(c)", ?™ => "(TM)", ?® => "(r)",
+    ?♥ => "<3",  ?☺ => ":)"
+  }
+
+  def self.process(string)
+    string = deumlautify string
+    #string = Ascii.process string
+    return string
+  end
+
+## TODO somebody find my a gem that works and I'll replace this
+  def self.deumlautify(string)
+    REPLACE_HASH.each{|k,v| string = string.gsub k, v }
+    string.each_char.to_a.keep_if {|c| c.ascii_only?}
+    return string
+  end
+
+  def self.clean_path(path)
+    path = path.strip()
+    path = deumlautify path
+    path.sub!(/^\./,'') # removes hidden_file_dot '.' from the begging
+    path.gsub!(/\//,'_') 
+    path.gsub!(/\//,'_') 
+    return path
+  end
+
+end

data/lib/luigi/gitplumber.rb

@@ -0,0 +1,151 @@
+# encoding: utf-8
+
+# # http://stackoverflow.com/questions/1891429/decorators-in-ruby-migrating-from-python
+# module Documenter
+#   def document(func_name)   
+#     old_method = instance_method(func_name) 
+# 
+#     define_method(func_name) do |*args|   
+#       puts "about to call #{func_name}(#{args.join(', ')})"  
+#       old_method.bind(self).call(*args)  
+#     end
+#   end
+# end
+
+require 'git'
+require 'logger'
+require 'textboxes'
+
+module GitPlumber
+
+  def open_git
+    return false unless @using_git
+    logger = Logger.new STDOUT
+    begin
+      @git = Git.open @dirs[:storage]
+      return true
+    rescue => error
+      logger.error "#{@dirs[:storage]} does not seem to be a git repository"
+      return false
+    end
+  end
+
+  def git_log(count = 30)
+    table = Textboxes.new
+    table.style[:border] = false
+    @git.log(count = count).to_a.reverse.each do |commit|
+      table.add_row [
+        commit.author.name,
+        commit.message,
+        commit.date.strftime("%H:%M Uhr — %d.%m.%Y"),
+      ]
+    end
+    puts table
+  end
+
+  def git_push()
+    @git = Git.open @dirs[:storage], :log => Logger.new(STDOUT)
+    out = @git.push()
+    puts out if out
+  end
+
+  def git_pull()
+    @git = Git.open @dirs[:storage], :log => Logger.new(STDOUT)
+    out = @git.pull()
+    puts out if out
+  end
+
+  def git_commit(message)
+    @git.commit(message)
+  end
+
+  def git_update_path path = @git.dir
+    return unless @settings['use_git']
+    if File.exists? path
+      @git.add path
+    else
+      @git.remove path, {:recursive => true}
+    end
+
+  end
+
+  def git_save message
+    puts "GITSAVE\n"
+    git_add()
+    @git.commit_all "ruby git #commit_all \"#{message}\""
+  end
+
+  def git_status
+    renamed = git_renamed_files
+    exclude = renamed.flatten
+    if @git.status.added.length + @git.status.deleted.length + @git.status.untracked.length + @git.status.changed.length == 0
+      puts "Nothing Changed"
+    end
+
+    git_print_status :added,      exclude
+    git_print_status :changed,    exclude
+    git_print_status :deleted,    exclude
+    git_print_status :untracked,  exclude
+    git_print_renamed renamed
+  end
+
+  def git_print_status name, exclude
+    case name
+      when :added     then status = @git.status.added
+      when :changed   then status = @git.status.changed
+      when :deleted   then status = @git.status.deleted
+      when :untracked then status = @git.status.untracked
+    end
+    status.reject! {|k,v| exclude.include? k }
+
+    puts "#{status.length} #{name.to_s.capitalize}:" if status.length > 0
+    status.each do |path, info|
+      case info.type
+      when "M" then color = :yellow
+      when "A" then color = :green
+      when "D" then color = :red
+      else color = :default
+      end
+      line = Paint[path, color]
+      state = " "
+      state = Paint[ "\e[32m✓\e[0m" , :green] if !info.sha_index.nil? and info.sha_index.to_i(16) > 0
+      puts "#{state} #{line}"
+    end
+    puts if status.length > 0
+  end
+
+  def git_renamed_files
+    repo_shas = {}
+    index_shas = {}
+    out = ""
+    files = []
+    @git.lib.diff_index('HEAD').each { |file, data|
+      sr = data[:sha_repo]
+      si = data[:sha_index]
+      repo_shas[sr] = file if sr.to_i(16) > 0
+      index_shas[si] = file if si.to_i(16) > 0
+      if index_shas.include? sr
+        files.push [ repo_shas[sr], index_shas[sr] ]
+      end
+    }
+    return files
+  end
+
+  def git_print_renamed files
+    puts "#{files.length} Renamed:" if files.length > 0
+    width = 0
+    files.map {|a,b| width = a.length if a.length > width}
+    out = ""
+    files.each {|a,b|
+      a = a.ljust(width)
+      out << Paint[ "\e[32m✓\e[0m" , :green] + " "
+      out << Paint[a, :red]
+      out << " -> "
+      out << Paint[b, :green]
+      out << "\n"
+    }
+    puts out if out.length > 0
+  end
+
+
+end

data/lib/luigi/version.rb

@@ -0,0 +1,3 @@
+module Luigi
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: luigi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hendrik Sollich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+- !ruby/object:Gem::Dependency
+  name: textboxes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: ''
+email: hendrik@hoodie.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/PlumberProject.rb
+- lib/luigi.rb
+- lib/luigi/ShellSanitizer.rb
+- lib/luigi/gitplumber.rb
+- lib/luigi/version.rb
+homepage: https://github.com/hoodie/luigi
+licenses:
+- GPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: luigi - a plumber
+test_files: []