lolcommits 0.1.5 → 0.2.0

data/.gitignore

@@ -3,4 +3,6 @@
 Gemfile.lock
 pkg/*
 .rvmrc
-
+results.html
+html
+tmp

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.2.0 (6 July 2012)
+  * improved build system and testing with cucumber/methadone
+    - goal is to get into a better framework to start doing major feature work
+    - this should lead to increased reliability across systems as we refactor
+  * writing tests (please help!)
+  * fix issues with packaged files not being readable after a sudo gem install
+
 0.1.5 (25 June 2012)
   * fix tranzlate on ruby1.8
 

data/README.md

@@ -1,11 +1,12 @@
-[![Build Status](https://secure.travis-ci.org/mroth/lolcommits.png?branch=master)](http://travis-ci.org/mroth/lolcommits)
-
-# git + webcam = lol
+# lolcommits (git + webcam = lol)
 
 Takes a snapshot with your Mac's built-in iSight/FaceTime webcam (or any working webcam on Linux) every time you git commit code, and archives a lolcat style image with it.
 
 By default, the lolimages are stored by a Github style short SHA in a `~/.lolcommits` directory created for you.
 
+[![Build Status](https://secure.travis-ci.org/mroth/lolcommits.png?branch=master)](http://travis-ci.org/mroth/lolcommits)
+[![Dependency Status](https://gemnasium.com/mroth/lolcommits.png)](https://gemnasium.com/mroth/lolcommits)
+
 ## Installation (Mac OS X)
 You'll need ImageMagick installed.  [Homebrew](http://mxcl.github.com/homebrew/) makes this easy.  Simply do:
 
@@ -74,22 +75,15 @@ environment variables.
  * TRANZLATE YOAR COMMIT_MSG TO LOLSPEKK - set
    `LOLCOMMITS_TRANZLATE=1`.
 
-## Troubles?
-Started a [FAQ](https://github.com/mroth/lolcommits/wiki/FAQ).
+## Contributing
 
-<!--
-## Upgrading from an old (non-gem) version?
-If you used the autoinstaller, here's how to get rid of the old stuff (I think)
+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
 
-For all active lolrepos, go into them and do:
+Please, if at all possible, write a passing test for the functionality you added.
 
-	git hooks --uninstall
-
-You might want to get rid of the copied binary for imagesnap and switch over to the homebrew-managed version, if so `rm /usr/local/bin/imagesnap`.
-
-If you want to get rid of git-hooks entirly (it won't hurt anything, but we dont use it anymore), you can also do:
-
-	rm /usr/local/bin/git-hooks
-	rm -rf ~/.git_hooks
-	rm -rf ~/.githooks_src
--->
+## Troubles?
+Started a [FAQ](https://github.com/mroth/lolcommits/wiki/FAQ).

data/Rakefile

@@ -1,13 +1,40 @@
-require "bundler/gem_tasks"
+require 'bundler'
+require 'rake/clean'
+
 require 'rake/testtask'
 
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
 Rake::TestTask.new do |t|
-  #t.libs << 'test'
-  t.test_files = Dir.glob('test/test_*.rb')
+  t.pattern = 'test/test_*.rb'
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
 end
 
-desc "Run tests"
-task :default => :test
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :default => [:test,:features]
+
+
 
 desc "Migrate an existing local .lolcommits directory to Dropbox"
 task :dropboxify do

data/bin/lolcommits

@@ -26,12 +26,20 @@ if is_mac?
   #  puts "Easiest way to get it is to install homebrew and do `brew install imagesnap`"
   #  exit 1
   #end
+  unless File.executable? File.join(LOLCOMMITS_ROOT, "ext", "imagesnap", "imagesnap")
+    puts "Couldn't properly execute imagesnap for some reason, please file a bug?!"
+    exit 1
+  end
 elsif is_linux?
   if not command?('mplayer')
     puts "Couldn't find mplayer in your PATH!"
     exit 1
   end
 end
+unless File.readable? File.join(LOLCOMMITS_ROOT, "fonts", "Impact.ttf")
+  puts "Couldn't properly read Impact font from gem package, please file a bug?!"
+  exit 1
+end
 
 #
 # NO ARGUMENTS SPECIFIED, HELP THE USER OUT

data/features/lolcommits.feature

@@ -0,0 +1,41 @@
+Feature: Basic functionality
+
+  Scenario: App just runs
+    When I get help for "lolcommits"
+    Then the exit status should be 0
+    And the banner should be present
+
+  Scenario: Enable in a naked git repository
+    Given a git repository named "loltest"
+    And the git repository named "loltest" has no "post-commit" hook
+    
+    When I cd to "loltest"
+    And I successfully run `lolcommits --enable`
+
+    Then the output should contain "installed lolcommmit hook as:"
+    And the output should contain "(to remove later, you can use: lolcommits --disable)"
+    And a file named ".git/hooks/post-commit" should exist
+    And the exit status should be 0
+
+  Scenario: Disable in a enabled git repository
+    Given a git repository named "lolenabled"
+    And the git repository named "lolenabled" has a "post-commit" hook
+
+    When I cd to "lolenabled"
+    And I successfully run `lolcommits --disable`
+
+    Then the output should contain "removed"
+    And a file named ".git/hooks/post-commit" should not exist
+    And the exit status should be 0
+
+  @simulate-capture
+  Scenario: Commiting in an enabled repo triggers capture
+    Given a git repository named "testcapture"
+    And an empty file named "testcapture/FOOBAR"
+    
+    When I cd to "testcapture"
+    And I successfully run `lolcommits --enable`
+    And I successfully run `git add .`
+    And I successfully run `git commit -m 'can haz commit'`
+    Then the output should contain "*** Preserving this moment in history."
+

data/features/step_definitions/lolcommits_steps.rb

@@ -0,0 +1,20 @@
+include FileUtils
+
+
+Given /^a git repository named "(.*?)"$/ do |repo_name|
+  repo_dir = File.join current_dir, repo_name
+  mkdir_p repo_dir
+  Dir.chdir repo_dir do
+    sh "git init ."
+  end
+end
+
+Given /^the git repository named "(.*?)" has no "(.*?)" hook$/ do |repo_name, hook_name|
+  hook_file = File.join current_dir, repo_name, ".git", "hooks", hook_name
+  delete(hook_file) if File.exists? hook_file
+end
+
+Given /^the git repository named "(.*?)" has a "(.*?)" hook$/ do |repo_name, hook_name|
+  hook_file = File.join current_dir, repo_name, ".git", "hooks", hook_name
+  touch(hook_file) if not File.exists? hook_file
+end

data/features/support/env.rb

@@ -0,0 +1,25 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+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
+
+Before('@simulate-capture') do
+  @original_fakecapture = ENV['LOLCOMMITS_FAKECAPTURE']
+  ENV['LOLCOMMITS_FAKECAPTURE'] = "1"
+end
+
+After('@simulate-capture') do
+  ENV['LOLCOMMITS_FAKECAPTURE'] = @original_fakecapture
+end

data/lib/lolcommits.rb

@@ -29,6 +29,10 @@ module Lolcommits
     end
   end
 
+  def is_fakecapture?
+    (ENV['LOLCOMMITS_FAKECAPTURE'] == '1' || false)
+  end
+
   def most_recent(dir='.')
     loldir, commit_sha, commit_msg = parse_git
     Dir.glob(File.join loldir, "*").max_by {|f| File.mtime(f)}
@@ -84,7 +88,11 @@ module Lolcommits
     #
     puts "*** Preserving this moment in history."
     snapshot_loc = File.join loldir, "tmp_snapshot.jpg"
-    if is_mac?
+    # if (ENV['LOLCOMMITS_FAKECAPTURE'] == '1' || false)
+    if is_fakecapture?
+      test_image = File.join LOLCOMMITS_ROOT, "test", "images", "test_image.jpg"
+      FileUtils.cp test_image, snapshot_loc
+    elsif is_mac?
       imagesnap_bin = File.join LOLCOMMITS_ROOT, "ext", "imagesnap", "imagesnap"
       capture_device = "-d '#{capture_device}'" if capture_device
       system("#{imagesnap_bin} -q #{snapshot_loc} -w #{capture_delay} #{capture_device}")

data/lib/lolcommits/version.rb

@@ -1,3 +1,3 @@
 module Lolcommits
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/lolcommits.gemspec

@@ -18,12 +18,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
-  s.add_development_dependency "rake"
-  s.add_runtime_dependency "rmagick"
-  s.add_runtime_dependency "git"
-  s.add_runtime_dependency "choice", ">= 0.1.6"
-  s.add_runtime_dependency "launchy"
+  s.add_runtime_dependency('rmagick', '~> 2.13.1')
+  s.add_runtime_dependency('git', '~> 1.2.5')
+  s.add_runtime_dependency('choice', '~> 0.1.6')
+  s.add_runtime_dependency('launchy')
+
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('aruba')
+  s.add_development_dependency('rake','~> 0.9.2')
+  s.add_dependency('methadone', '~>1.2.1')
 end

data/test/test_lolcommits.rb

@@ -14,6 +14,9 @@ class LolTest < Test::Unit::TestCase
         end
     end
 
+    #
+    # issue #57, https://github.com/mroth/lolcommits/issues/57
+    #
     def test_tranzlate
         [["what the hell","(WH|W)UT TEH HELL"],["seriously wtf", "SRSLEH WTF"]].each do |normal, lol|
             tranzlated = normal.tranzlate
@@ -21,10 +24,20 @@ class LolTest < Test::Unit::TestCase
         end
     end
 
+    #
+    # issue #53, https://github.com/mroth/lolcommits/issues/53
+    # this will test the permissions but only locally, important before building a gem package!
+    #
+    def test_permissions
+        assert File.readable? File.join(LOLCOMMITS_ROOT, "fonts", "Impact.ttf")
+        assert File.executable? File.join(LOLCOMMITS_ROOT, "ext", "imagesnap", "imagesnap")
+    end
+
     # Hmm.. webcam capture breaks travis-ci tests
     #def test_can_capture
     #    assert_nothing_raised do
     #        Lolcommits.capture(0,true,'test commit message','test-sha-001')
     #    end
     #end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,17 +9,65 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-26 00:00:00.000000000 Z
+date: 2012-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: choice
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: launchy
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -28,14 +76,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rmagick
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -44,14 +92,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: git
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -60,37 +108,37 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: choice
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.6
-  type: :runtime
+        version: 0.9.2
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
-  name: launchy
+  name: methadone
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
 description: Takes a snapshot with your Mac's built-in iSight/FaceTime webcam (or
   any working webcam on Linux or Windows) every time you git commit code, and archives
   a lolcat style image with it.
@@ -114,11 +162,15 @@ files:
 - ext/CommandCam/LICENSE
 - ext/imagesnap/ReadMeOrDont.rtf
 - ext/imagesnap/imagesnap
+- features/lolcommits.feature
+- features/step_definitions/lolcommits_steps.rb
+- features/support/env.rb
 - fonts/Impact.ttf
 - lib/lolcommits.rb
 - lib/lolcommits/version.rb
 - lib/tranzlate/lolspeak.rb
 - lolcommits.gemspec
+- test/images/test_image.jpg
 - test/test_lolcommits.rb
 homepage: http://github.com/mroth/lolcommits
 licenses:
@@ -146,4 +198,8 @@ signing_key:
 specification_version: 3
 summary: Capture webcam image on git commit for lulz.
 test_files:
+- features/lolcommits.feature
+- features/step_definitions/lolcommits_steps.rb
+- features/support/env.rb
+- test/images/test_image.jpg
 - test/test_lolcommits.rb