linknew 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6c6b7c93b7e8cc4900ddbb1fde23831a900c80f
-  data.tar.gz: 48348457b5ce6d09b444093577cae419bd306c60
+  metadata.gz: 36510999112b009ba352a5d2973b854f716f1b16
+  data.tar.gz: b6d6c9c6469533ac8e065b6ceb94dc211f248d17
 SHA512:
-  metadata.gz: ca8f77e90a2538af6cc184ec447b52904ef19b0588333198699d4dd5dac8768b7beb8b16e7670c6b776eb828079a2456b755e9660619cf4b19a0f85d9b39cd35
-  data.tar.gz: 41ce550e857c0422cd70dfce70832beed638f0df2365e508d146827a38c618a9e3346326600f638856fb85b6c89eceaa4f3c298321e314680afef59ace95b2fe
+  metadata.gz: 489226b608ed6671ec8eeb26e5887dc8aaf8904910e60e909acad3800f9d79b2450c1e1070cd02e2b53d21fe9b30a49617031584ab49212572396c16c989ccff
+  data.tar.gz: 4c1b9e2062d52a2caa76e3929148a57baab17bf8767139255e92b50434737315159bcc5a8d65cb4b44a789ba171e4b55ba6c9da4ba5422ae20e6e9ca90ca2f08

data/.rubocop.yml

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

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.1.5

data/.travis.yml

@@ -2,4 +2,3 @@ language: ruby
 rvm:
   - 2.2.0-preview2
   - 2.1.5
-  - rbx-2.2.7

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in linknew.gemspec
 gemspec
+gem 'coveralls', group: :test, require: false

data/README.md

@@ -1,7 +1,7 @@
 [![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)
+[![Coverage Status](https://img.shields.io/coveralls/voidus/linknew.svg)](https://coveralls.io/r/voidus/linknew?branch=master)
 [![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)
@@ -22,7 +22,7 @@ $ gem install linknew
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/linknew/fork )
+1. Fork it ( https://github.com/voidus/linknew/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,10 +1,24 @@
 require 'bundler/gem_tasks'
+
 require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-require 'reek/rake/task'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.verbose = false
+  task.rspec_opts = '-w'
+end
 
-RSpec::Core::RakeTask.new(:spec)
+require 'rubocop/rake_task'
 RuboCop::RakeTask.new { |config| config.fail_on_error = false }
+
+require 'reek/rake/task'
 Reek::Rake::Task.new { |config| config.fail_on_error = false }
 
-task default: [:spec, :rubocop, :reek]
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+require 'yard'
+YARD::Rake::YardocTask.new(:doc) do |yard|
+  yard.files = ['bin/**/*.rb', 'lib/**/*.rb']
+  yard.options = ['--readme', 'README.md', '--files', 'CHANGELOG.md,LICENSE.txt']
+end
+
+task default: [:spec, :features, :rubocop, :reek]

data/bin/linknew

@@ -1,17 +1,33 @@
 #!/usr/bin/env ruby
-require 'linknew'
 
-CONFIG_FILE = '.linknew'
-HELP_MESSAGE = <<HERE
+require 'optparse'
+require 'methadone'
+require 'linknew.rb'
 
-HERE
+# The command-line application for linknew
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
 
-unless File.exist? CONFIG_FILE
-  abort 'Usage: Put a target location in .linknew and run the script'
-end
+  CONFIG_FILE = '.linknew'
+
+  main do # Add args you want: |like,so|
+    # your program code here
+    # You can access CLI options via
+    # the options Hash
+
+    help_now! 'Put a target location in .linknew and run the script' unless File.exist? CONFIG_FILE
+
+    folder = IO.read(CONFIG_FILE).strip
+    help_now! "The folder \"#{folder}\" does not exist" unless File.exist? folder
+    help_now! "The folder \"#{folder}\" is not a directory" unless File.directory? folder
 
-folder = IO.read(CONFIG_FILE).strip
-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
+  end
 
-Linknew::Linknew.new(folder).execute
+  version Linknew::VERSION
+
+  use_log_level_option toggle_debug_on_signal: 'USR1'
+
+  go!
+end

data/features/linknew.feature

@@ -0,0 +1,13 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "linknew"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version|
+    And the banner should document that this app takes no arguments

data/features/step_definitions/linknew_steps.rb

@@ -0,0 +1 @@
+# Put your step definitions here

data/features/support/env.rb

@@ -0,0 +1,18 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+binpath = File.expand_path(File.dirname(__FILE__) + '/../../bin')
+ENV['PATH'] = "#{binpath}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+# extra library dir to use in feature tests
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/linknew.rb

@@ -10,6 +10,11 @@ require 'linknew/database'
 module Linknew
   # The main linknew class
   class Linknew
+    include Methadone::CLILogging
+
+    # Initializes the applicatioin
+    #
+    # @param folder [String] The name of the folder to which links wil be created
     def initialize(folder)
       @folder = folder
       abort('Target folder does not exist') unless File.exist? folder
@@ -17,7 +22,7 @@ module Linknew
 
     # Runs the program
     def execute
-      puts MTIME_WARNING_MESSAGE unless CAN_SET_MTIME
+      warn MTIME_WARNING_MESSAGE unless CAN_SET_MTIME
 
       Database.new do |db|
         scan_files(db)
@@ -27,7 +32,7 @@ module Linknew
     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$/
+    CAN_SET_MTIME = RUBY_PLATFORM =~ /linux/
 
     def scan_files(db)
       Dir.foreach(@folder) do |file|
@@ -40,7 +45,7 @@ module Linknew
 
     def process_file(file, db)
       linkname = File.basename(file)
-      puts "Linking #{linkname}"
+      info "Linking #{linkname}"
       File.symlink(file, linkname)
       `touch -h #{linkname.shellescape} -r #{file.shellescape}` if CAN_SET_MTIME
       db.enter(file)

data/lib/linknew/database.rb

@@ -1,8 +1,16 @@
 require 'digest'
+require 'methadone/cli_logging'
 
 module Linknew
   # Encapsules the linknew database
   class Database
+    include ::Methadone::CLILogging
+
+    # Opens (and possibly creates) the database. If no block is given, ensure that #close is called.
+    #
+    # For a block { |db| ... }
+    # @yield |db| Gives self to the block
+    # @yieldparam db [Database] self
     def initialize(&block)
       @db = SQLite3::Database.new '.linknew.db'
       creates_tables_if_not_exist
@@ -16,21 +24,29 @@ module Linknew
       end
     end
 
+    # Closes the connection to the database. The object is invalid after the call.
     def close
       @db.close
     end
 
+    # Checks if the file is in the database
+    #
+    # @param file [String] The file name to check for
+    # @return [Boolean] Whether the file is in the database.
     def known?(file)
       hash = Database.filehash(file)
-      p "Querying file #{file} with hash #{hash}"
+      debug "Querying file #{file} with hash #{hash}"
       ret = @db.execute(HAS_FILE_STMT, hash)[0][0] == 1
-      p "Returning #{ret}"
+      debug "-> Returning #{ret}"
       ret
     end
 
+    # Enters the file in the database
+    #
+    # @param file [String] The filename to enter
     def enter(file)
       hash = Database.filehash(file)
-      p "Entering file #{file} with hash #{hash}"
+      debug "Entering file #{file} with hash #{hash}"
       @db.execute(ENTER_FILE_STMT, hash)
     end
 

data/lib/linknew/version.rb

@@ -1,3 +1,4 @@
 module Linknew # rubocop:disable Documentation
-  VERSION = '1.0.0'
+  # The current version
+  VERSION = '1.1.0'
 end

data/linknew.gemspec

@@ -22,10 +22,16 @@ HERE
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'sqlite3', '~>1.3'
+  spec.add_runtime_dependency 'sqlite3', '~> 1.3'
+  spec.add_runtime_dependency 'methadone', '~> 1.5'
+
   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'
+  spec.add_development_dependency 'reek', '~> 1.5'
+  spec.add_development_dependency 'cucumber', '~> 1.3'
+  spec.add_development_dependency 'aruba', '~> 0.6'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'yard', '~> 0.8'
 end

data/spec/spec_helper.rb

@@ -1,2 +1,23 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/features/'
+end
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'methadone/cli_logger'
+require 'methadone/cli_logging'
+require 'logger'
+
+Class.new do
+  include Methadone::CLILogging
+  change_logger Methadone::CLILogger.new unless logger
+  logger.level = Logger::ERROR
+end
+
 require 'linknew'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linknew
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Simon Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +98,72 @@ dependencies:
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 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
@@ -116,6 +186,9 @@ files:
 - README.md
 - Rakefile
 - bin/linknew
+- features/linknew.feature
+- features/step_definitions/linknew_steps.rb
+- features/support/env.rb
 - lib/linknew.rb
 - lib/linknew/database.rb
 - lib/linknew/version.rb
@@ -147,5 +220,9 @@ signing_key:
 specification_version: 4
 summary: Links to files in a directory once
 test_files:
+- features/linknew.feature
+- features/step_definitions/linknew_steps.rb
+- features/support/env.rb
 - spec/linknew_spec.rb
 - spec/spec_helper.rb
+has_rdoc: