linknew 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c04c6b5ad914e84907496cea235c7b947a2cd15e
-  data.tar.gz: 504c98bc166e1d8e0c8429edcdff8b3817e07715
+  metadata.gz: d6c6b7c93b7e8cc4900ddbb1fde23831a900c80f
+  data.tar.gz: 48348457b5ce6d09b444093577cae419bd306c60
 SHA512:
-  metadata.gz: 1d7a3655abe3e22f6b96e87e81dd9ae8d4f79fb87a413903ee3ce1e90b34e192397c60f1351c176c9c78281f6ead3edaa607b68fdb0320b22b58e85317e6b6f6
-  data.tar.gz: 068bd4a2c0fefa212c5ce7e1f47d8345906e34736c5f3aed9512ecd8888d42f5ab63174f8144de7d7b9485c43f877dfc48366c391e9caf62034ecb46e2a9e237
+  metadata.gz: ca8f77e90a2538af6cc184ec447b52904ef19b0588333198699d4dd5dac8768b7beb8b16e7670c6b776eb828079a2456b755e9660619cf4b19a0f85d9b39cd35
+  data.tar.gz: 41ce550e857c0422cd70dfce70832beed638f0df2365e508d146827a38c618a9e3346326600f638856fb85b6c89eceaa4f3c298321e314680afef59ace95b2fe

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 99

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.2
+  - 2.2.0-preview2
+  - 2.1.5
+  - rbx-2.2.7

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.0.0 / 2014-12-07
+* [FEATURE] Set the mtime of the link on unix systems
+* [ENHANCEMENT] Considered stable now, I have been using it for a few months.
+
+# 0.0.1 / 2014-10-12
+* [FEATURE] Basic functionality, links to new files exactly once

data/README.md

@@ -1,3 +1,11 @@
+[![Gem Version](https://badge.fury.io/rb/linknew.png)](http://rubygems.org/gems/linknew)
+[![Build Status](https://secure.travis-ci.org/voidus/linknew.png?branch=master)](https://travis-ci.org/voidus/linknew)
+[![Code Climate](https://codeclimate.com/github/voidus/linknew.png)](https://codeclimate.com/github/voidus/linknew)
+[![Coverage Status](https://coveralls.io/repos/voidus/linknew/badge.png?branch=master)](https://coveralls.io/r/voidus/linknew)
+[![Dependencies](https://gemnasium.com/voidus/linknew.png)](https://gemnasium.com/voidus/linknew)
+[![Documentation](http://inch-ci.org/github/voidus/linknew.svg?branch=master)](http://inch-ci.org/github/voidus/linknew)
+[![PullReview stats](https://www.pullreview.com/github/voidus/linknew/badges/master.svg?)](https://www.pullreview.com/github/voidus/linknew/reviews/master)
+
 # Linknew
 
 Linknew creates links to all files in another directory once. You can use it to keep track of which files in a shared

data/Rakefile

@@ -1,7 +1,10 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'reek/rake/task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new { |config| config.fail_on_error = false }
+Reek::Rake::Task.new { |config| config.fail_on_error = false }
 
-task :default => :spec
-
+task default: [:spec, :rubocop, :reek]

data/bin/linknew

@@ -1,21 +1,17 @@
 #!/usr/bin/env ruby
 require 'linknew'
 
-CONFIG_FILE = ".linknew"
+CONFIG_FILE = '.linknew'
 HELP_MESSAGE = <<HERE
 
 HERE
 
-unless File.exists? CONFIG_FILE
-  abort "Usage: Put a target location in .linknew and run the script"
+unless File.exist? CONFIG_FILE
+  abort 'Usage: Put a target location in .linknew and run the script'
 end
 
 folder = IO.read(CONFIG_FILE).strip
-unless File.exists? folder
-  abort "The folder \"#{folder}\" does not exist"
-end
-unless File.directory? folder
-  abort "The folder \"#{folder}\" is not a directory"
-end
+abort "The folder \"#{folder}\" does not exist" unless File.exist? folder
+abort "The folder \"#{folder}\" is not a directory" unless File.directory? folder
 
 Linknew::Linknew.new(folder).execute

data/lib/linknew.rb

@@ -1,27 +1,49 @@
-require "linknew/version"
-require "sqlite3"
+require 'linknew/version'
+require 'sqlite3'
+require 'fileutils'
+require 'shellwords'
 
 require 'linknew/database'
 
+# Linknew is an application, and while it's code might be benificial in some situations, the api
+# shouldn't be that important.
 module Linknew
+  # The main linknew class
   class Linknew
-    def initialize folder
+    def initialize(folder)
       @folder = folder
-      abort("Target folder does not exist") unless File.exists? folder
+      abort('Target folder does not exist') unless File.exist? folder
     end
 
+    # Runs the program
     def execute
-      db = Database.new
+      puts MTIME_WARNING_MESSAGE unless CAN_SET_MTIME
+
+      Database.new do |db|
+        scan_files(db)
+      end
+    end
+
+    private
+
+    MTIME_WARNING_MESSAGE = 'WARNING: Not running on linux, will not set mtime of symbolic links.'
+    CAN_SET_MTIME = RUBY_PLATFORM =~ /linux/ && !$PROGRAM_NAME =~ /\brspec$/
+
+    def scan_files(db)
       Dir.foreach(@folder) do |file|
-        next if file == "." || file == ".."
-        file = File.join(@folder, file)
+        next if file == '.' || file == '..'
 
-        unless db.has_file? file
-          puts "Linking #{File.basename(file)}"
-          File.symlink(file, File.basename(file))
-          db.enter_file(file)
-        end
+        file = File.join(@folder, file)
+        process_file(file, db) unless db.known? file
       end
     end
+
+    def process_file(file, db)
+      linkname = File.basename(file)
+      puts "Linking #{linkname}"
+      File.symlink(file, linkname)
+      `touch -h #{linkname.shellescape} -r #{file.shellescape}` if CAN_SET_MTIME
+      db.enter(file)
+    end
   end
 end

data/lib/linknew/database.rb

@@ -1,28 +1,50 @@
-require 'linknew/errors'
 require 'digest'
 
 module Linknew
+  # Encapsules the linknew database
   class Database
-    def initialize
-      @db = SQLite3::Database.new ".linknew.db"
-      @db.execute "CREATE TABLE IF NOT EXISTS files (md5name char(32))"
-      @db.execute "CREATE INDEX IF NOT EXISTS files_md5name ON files (md5name)"
+    def initialize(&block)
+      @db = SQLite3::Database.new '.linknew.db'
+      creates_tables_if_not_exist
 
-      @has_file_stmt = @db.prepare("SELECT EXISTS(SELECT 1 FROM files WHERE md5name = ? LIMIT 1)")
-      @enter_file_stmt = @db.prepare("INSERT INTO files VALUES (?)")
+      return unless block_given?
+
+      begin
+        block.call(self)
+      ensure
+        close
+      end
+    end
+
+    def close
+      @db.close
     end
 
-    def has_file? file
-      @has_file_stmt.execute(filehash(file)).next[0] == 1
+    def known?(file)
+      hash = Database.filehash(file)
+      p "Querying file #{file} with hash #{hash}"
+      ret = @db.execute(HAS_FILE_STMT, hash)[0][0] == 1
+      p "Returning #{ret}"
+      ret
     end
 
-    def enter_file file
-      @enter_file_stmt.execute(filehash(file))
+    def enter(file)
+      hash = Database.filehash(file)
+      p "Entering file #{file} with hash #{hash}"
+      @db.execute(ENTER_FILE_STMT, hash)
     end
 
     private
 
-    def filehash file
+    HAS_FILE_STMT = 'SELECT EXISTS(SELECT 1 FROM files WHERE md5name = ? LIMIT 1)'
+    ENTER_FILE_STMT = 'INSERT INTO files VALUES (?)'
+
+    def creates_tables_if_not_exist
+      @db.execute 'CREATE TABLE IF NOT EXISTS files (md5name char(32))'
+      @db.execute 'CREATE INDEX IF NOT EXISTS files_md5name ON files (md5name)'
+    end
+
+    def self.filehash(file)
       ::Digest::MD5.hexdigest(File.basename(file))
     end
   end

data/lib/linknew/version.rb

@@ -1,3 +1,3 @@
-module Linknew
-  VERSION = "0.0.2"
+module Linknew # rubocop:disable Documentation
+  VERSION = '1.0.0'
 end

data/linknew.gemspec

@@ -4,25 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'linknew/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "linknew"
+  spec.name          = 'linknew'
   spec.version       = Linknew::VERSION
-  spec.authors       = ["Simon Kohlmeyer"]
-  spec.email         = ["simon.kohlmeyer@gmail.com"]
-  spec.summary       = %q{Links to files in a directory once}
+  spec.authors       = ['Simon Kohlmeyer']
+  spec.email         = ['simon.kohlmeyer@gmail.com']
+  spec.summary       = 'Links to files in a directory once'
   spec.description   = <<HERE
-Linknew creates links to all files in another directory once. You can use it to keep track of which files in a shared
-directory you already looked at.
+Linknew creates links to all files in another directory once.
+You can use it to keep track of which files in a shared directory you already
+looked at.
 HERE
-  spec.homepage      = "http://github.com/voidus/linknew"
-  spec.license       = "MIT"
+  spec.homepage      = 'http://github.com/voidus/linknew'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "sqlite3", "~>1.3"
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_dependency 'sqlite3', '~>1.3'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rubocop', '~> 0.27.1'
+  spec.add_development_dependency 'reek'
 end

data/spec/linknew_spec.rb

@@ -1,11 +1,60 @@
 require 'spec_helper'
+require 'tmpdir'
 
 describe Linknew do
+  before(:all) { @original_wd = Dir.pwd }
+  after(:all) { Dir.chdir(@original_wd) }
+
+  before(:each) do
+    @source_dir = Dir.mktmpdir('src_')
+    @work_dir = Dir.mktmpdir('dst_')
+
+    @testfile = 'some_file'
+
+    @testfile_source = File.join(@source_dir, @testfile)
+    @testfile_work = File.join(@work_dir, @testfile)
+
+    FileUtils.touch(@testfile_source)
+    Dir.chdir(@work_dir)
+  end
+
+  after(:each) do
+    FileUtils.remove_entry @source_dir
+    FileUtils.remove_entry @work_dir
+  end
+
+  def call_linknew
+    Linknew::Linknew.new(@source_dir).execute
+  end
+
   it 'has a version number' do
     expect(Linknew::VERSION).not_to be nil
   end
 
-  it 'does something useful' do
-    expect(false).to eq(true)
+  it 'creates a database file' do
+    call_linknew
+    expect(::File).to exist('.linknew.db')
+  end
+
+  it 'creates a database file' do
+    call_linknew
+    expect(File.exist?('.linknew.db'))
+  end
+
+  it 'creates a link to a new file' do
+    call_linknew
+    expect(File).to exist(@testfile_work)
+  end
+
+  it 'also works without to' do
+    call_linknew
+    expect(File.exist?(@testfile_work))
+  end
+
+  it 'ignores already linked files on the second run when the link has been deleted' do
+    call_linknew
+    File.delete(@testfile_work)
+    call_linknew
+    expect(File).not_to exist(@testfile_work)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linknew
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Simon Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -54,6 +54,34 @@ dependencies:
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+- !ruby/object:Gem::Dependency
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,8 +95,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |
-  Linknew creates links to all files in another directory once. You can use it to keep track of which files in a shared
-  directory you already looked at.
+  Linknew creates links to all files in another directory once.
+  You can use it to keep track of which files in a shared directory you already
+  looked at.
 email:
 - simon.kohlmeyer@gmail.com
 executables:
@@ -78,8 +107,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,7 +118,6 @@ files:
 - bin/linknew
 - lib/linknew.rb
 - lib/linknew/database.rb
-- lib/linknew/errors.rb
 - lib/linknew/version.rb
 - linknew.gemspec
 - spec/linknew_spec.rb

data/lib/linknew/errors.rb

@@ -1,4 +0,0 @@
-module Linknew
-  class Error < StandardError; end
-  class FileNotFoundError < Error; end
-end