punchcard 0.1.4 → 0.2.0

data/.gitignore

@@ -1,7 +1,8 @@
-## MAC OS
 .DS_Store
+
 .bundle
 .sass-cache
+*.sqlite*
 
 ## TEXTMATE
 *.tmproj

data/Gemfile

@@ -1,4 +1,3 @@
 source :rubygems
 
-gemspec
-gem 'sinatra-mongoid', :require => 'sinatra/mongoid', :git => 'https://github.com/robertoles/sinatra-mongoid.git'
+gemspec

data/Gemfile.lock

@@ -1,63 +1,60 @@
-GIT
-  remote: https://github.com/robertoles/sinatra-mongoid.git
-  revision: f0d04640b84306a5d1e08569c9d12e9841e908b1
-  specs:
-    sinatra-mongoid (0.0.2)
-      mongo_ext
-      mongoid
-      sinatra
-
 PATH
   remote: .
   specs:
-    punchcard (0.1.2)
+    punchcard (0.1.4)
+      activerecord (~> 3.0.0)
       bson_ext
       gravtastic
       haml (>= 3.0.24)
-      mongoid
       sass (>= 3.0.0)
       sinatra (>= 1.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (2.3.10)
-    bson (1.0.9)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.3)
+    arel (2.0.6)
     bson_ext (1.1.4)
-    durran-validatable (2.0.1)
+    builder (2.1.2)
+    ffi (1.0.1)
+      rake (>= 0.8.7)
     gravtastic (3.1.0)
     haml (3.0.24)
-    mongo (1.0.9)
-      bson (>= 1.0.5)
-    mongo_ext (0.19.3)
-    mongoid (1.9.2)
-      activesupport (< 3.0.0)
-      bson (~> 1.0.1)
-      durran-validatable (>= 2.0.1)
-      mongo (~> 1.0.1)
-      will_paginate (< 2.9)
+    i18n (0.5.0)
     rack (1.2.1)
     rack-test (0.5.6)
       rack (>= 1.0)
+    rake (0.8.7)
     sass (3.1.0.alpha.200)
     shoulda (2.10.3)
     sinatra (1.1.0)
       rack (~> 1.1)
       tilt (~> 1.1)
+    sqlite3 (0.1.1)
+      ffi (>= 0.6.3)
     tilt (1.1)
-    will_paginate (2.3.15)
+    tzinfo (0.3.23)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (~> 3.0.0)
   bson_ext
   gravtastic
   haml (>= 3.0.24)
-  mongoid
   punchcard!
   rack-test (>= 0.5.6)
   sass (>= 3.0.0)
   shoulda (= 2.10.3)
   sinatra (>= 1.0.0)
-  sinatra-mongoid!
+  sqlite3

data/README.rdoc

@@ -2,42 +2,56 @@
 
 A simple Sinatra app that lets you track who is and has been in the office at what times.
 
-== Setup (theory)
-
-Create a folder for your app, add a Gemfile:
+== Bootstrap
   
+Create a directory to hold your app, then create a Gemfile:
+
   source :rubygems
-  gem 'punchcard'
+  gem 'pg'
+  # gem 'sqlite3' # if you want to run using sqlite or test locally
+  gem 'punchcard', ">= 0.1.3", :path => '../github/punchcard'
+  
+Create a Rakefile:
+
+  require 'bundler'
+  require 'rake'
+  Bundler.require
 
-Run bundle install. You'll also need a config.ru that looks like this:
+  require 'punchcard/tasks'
+  
+Create a config.ru for rack:
 
   require 'bundler'
   Bundler.require
-  Punchcard.set :mongo_db, 'punchcard'
+
+  # You'll surely want to secure your punch card from general web access. The simplest way to do so is by
+  # using the rack auth middleware, defining it somewhere in your config.ru:
+  Punchcard.use Rack::Auth::Basic do |username, password|
+    [username, password] == ['someuser', 'secret']
+  end
+
   run Punchcard
   
-Now running rackup should launch punchcard.
-  
-== Setup (for real on Heroku)
+To run locally, make sure you have a proper ENV['DATABASE_URL'] configured or the sqlite3 gem installed
+with your bundle. Then:
+
+  $ bundle install
+  $ rake db:migrate
+  $ rackup
+
+Open http://localhost:9292
+
+== Hosting on Heroku
 
-Same as above, but you can ditch the mongo_db setup line. Initialize a git repo in your folder
+Starting from the initial bootstrap above, make sure you have the pg gem in your bundle, then do the
+following in the terminal:
 
   $ git init
-  $ git commit -a -m "Initial commit"
+  $ git commit -am "Initial commit"
   $ heroku create [APPNAME] --stack bamboo-mri-1.9.2
-  $ heroku addons:add mongohq:free
   $ git push heroku master
   
-Now head over to your app's url! Please also check out the next two sections for auth and adding people.
-  
-== Authentication
-
-You'll surely want to secure your punch card from general web access. The simplest way to do so is by
-using the rack auth middleware by defining it somewhere in your config.ru:
-
-  Punchcard.use Rack::Auth::Basic do |username, password|
-    [username, password] == ['admin', 'admin']
-  end
+Now head over to your app's url! You'll still need to add users, see below.
   
 == Adding people
 

data/Rakefile

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "punchcard"
-    gem.summary = %Q{Simple sinatra/mongodb app for tracking time when people have been in the office}
-    gem.description = %Q{Simple sinatra/mongodb app for tracking time when people have been in the office}
+    gem.summary = %Q{Simple sinatra/activerecord based app for tracking time when people have been in the office}
+    gem.description = %Q{Simple sinatra/activerecord based app for tracking time when people have been in the office}
     gem.email = "christoph at olszowka de"
     gem.homepage = "http://github.com/colszowka/punchcard"
     gem.authors = ["Christoph Olszowka"]
@@ -14,10 +14,11 @@ begin
     gem.add_dependency 'bson_ext', '>= 0'
     gem.add_dependency 'haml', '>= 3.0.24'
     gem.add_dependency 'sass', '>= 3.0.0'
-    gem.add_dependency 'mongoid', '>= 0'
+    gem.add_dependency 'activerecord', '~> 3.0.0'
     gem.add_dependency 'gravtastic', '>= 0'
     gem.add_development_dependency "shoulda", "2.10.3"
     gem.add_development_dependency "rack-test", ">= 0.5.6"
+    gem.add_development_dependency 'sqlite3', '>= 0'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/lib/db/migrate/01_create_people.rb

@@ -0,0 +1,13 @@
+class CreatePeople < ActiveRecord::Migration
+  def self.up
+    create_table :people do |t|
+      t.string :name,  :null => false
+      t.string :email, :null => false
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :people
+  end
+end

data/lib/db/migrate/02_create_punches.rb

@@ -0,0 +1,14 @@
+class CreatePunches < ActiveRecord::Migration
+  def self.up
+    create_table :punches do |t|
+      t.integer  :person_id, :null => false
+      t.datetime :checked_in_at, :null => false
+      t.datetime :checked_out_at, :default => nil
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :people
+  end
+end

data/lib/punchcard/person.rb

@@ -1,12 +1,5 @@
-class Person
-  include Mongoid::Document
-
-  field :name
-  field :email
-  
-  index :name, :unique => true
-  
-  embeds_many :punches
+class Person < ActiveRecord::Base
+  has_many :punches
   
   validates_presence_of :name, :email
   
@@ -15,14 +8,14 @@ class Person
   
   # Returns the currently pending punch when present, nil otherwise
   def pending?
-    punches.pending.first
+    punches.pending.count > 0 ? punches.pending.first : nil
   end
   
   # Punches in when no punches pending, punches out when a pending punch exists!
   # When punching in, checks whether a recently finished punch exists and reopens if so instead
   # of creating a new punch
   def punch!
-    if punch = punches.pending.first
+    if punch = pending?
       punch.punch_out!
     else
       if recently_finished = punches.recently_finished.first

data/lib/punchcard/punch.rb

@@ -1,16 +1,12 @@
-class Punch
-  include Mongoid::Document
-  field :checked_in_at, :type => Time
-  field :checked_out_at, :type => Time
-  
-  embedded_in :person, :inverse_of => :punches
-  
-  scope :pending, where(:checked_out_at.exists => false)
-  scope :finished, where(:checked_out_at.exists => true, :checked_in_at.exists => true)
-  scope :recently_finished, where(:checked_out_at.gt => 30.minutes.ago)
-  
+class Punch < ActiveRecord::Base
+  belongs_to :person
+
   validates_presence_of :checked_in_at
   
+  scope :pending, where("checked_out_at IS NULL").order("checked_in_at ASC")
+  scope :finished, where("checked_in_at IS NOT NULL AND checked_out_at IS NOT NULL").order('checked_out_at DESC')
+  scope :recently_finished, where("checked_out_at > ?", 30.minutes.ago).order('checked_out_at DESC')
+  
   before_validation do |p|
     p.checked_in_at ||= Time.now
   end
@@ -19,6 +15,13 @@ class Punch
     p.errors.add :person, "Person already has a pending punch!" if p.person.pending? and p.person.pending? != p
   end
   
+  after_save do |p|
+    # Destroy punches shorter than 5 minutes
+    if p.checked_out_at.present? and (p.checked_out_at - p.checked_in_at) < 5.minutes
+      p.destroy
+    end
+  end
+  
   # Punches this punch out when pending
   def punch_out!
     return false if checked_out_at.present?

data/lib/punchcard/tasks.rb

@@ -0,0 +1,11 @@
+# Rake tasks for punchcard, import with require 'punchcard/tasks'
+
+namespace :db do
+  desc "Migrate the database"
+  task(:migrate) do
+    require 'logger'
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+    ActiveRecord::Migration.verbose = false
+    ActiveRecord::Migrator.migrate(File.join(File.dirname(__FILE__), "../db/migrate"))
+  end
+end

data/lib/punchcard.rb

@@ -2,9 +2,14 @@ require 'bundler'
 Bundler.setup(:default)
 
 require 'sinatra'
-require 'sinatra/mongoid'
 require 'gravtastic'
-require 'mongoid'
+require 'active_record'
+
+require 'logger'
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+ActiveRecord::Base.logger.level = Logger::WARN
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'] || {:adapter => 'sqlite3', :database => "punchcard_#{ENV['RACK_ENV'] || 'development'}.sqlite3"})
 
 require 'punchcard/person'
 require 'punchcard/punch'
@@ -18,7 +23,7 @@ class Punchcard < Sinatra::Base
   end
   
   get '/status.json' do
-    Person.order_by(:name).all.to_json
+    Person.order('name ASC').map(&:payload).to_json
   end
   
   post '/punch/:id' do

data/punchcard.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{punchcard}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christoph Olszowka"]
-  s.date = %q{2010-12-08}
-  s.description = %q{Simple sinatra/mongodb app for tracking time when people have been in the office}
+  s.date = %q{2010-12-09}
+  s.description = %q{Simple sinatra/activerecord based app for tracking time when people have been in the office}
   s.email = %q{christoph at olszowka de}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -26,12 +26,15 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "config.ru",
+     "lib/db/migrate/01_create_people.rb",
+     "lib/db/migrate/02_create_punches.rb",
      "lib/public/cardbg.png",
      "lib/public/css/blueprint.css",
      "lib/public/js/app.js",
      "lib/punchcard.rb",
      "lib/punchcard/person.rb",
      "lib/punchcard/punch.rb",
+     "lib/punchcard/tasks.rb",
      "lib/views/index.haml",
      "lib/views/layout.haml",
      "lib/views/screen.sass",
@@ -44,7 +47,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Simple sinatra/mongodb app for tracking time when people have been in the office}
+  s.summary = %q{Simple sinatra/activerecord based app for tracking time when people have been in the office}
   s.test_files = [
     "test/helper.rb",
      "test/test_database.rb",
@@ -60,29 +63,32 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<bson_ext>, [">= 0"])
       s.add_runtime_dependency(%q<haml>, [">= 3.0.24"])
       s.add_runtime_dependency(%q<sass>, [">= 3.0.0"])
-      s.add_runtime_dependency(%q<mongoid>, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.0"])
       s.add_runtime_dependency(%q<gravtastic>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, ["= 2.10.3"])
       s.add_development_dependency(%q<rack-test>, [">= 0.5.6"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
     else
       s.add_dependency(%q<sinatra>, [">= 1.0.0"])
       s.add_dependency(%q<bson_ext>, [">= 0"])
       s.add_dependency(%q<haml>, [">= 3.0.24"])
       s.add_dependency(%q<sass>, [">= 3.0.0"])
-      s.add_dependency(%q<mongoid>, [">= 0"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
       s.add_dependency(%q<gravtastic>, [">= 0"])
       s.add_dependency(%q<shoulda>, ["= 2.10.3"])
       s.add_dependency(%q<rack-test>, [">= 0.5.6"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
     end
   else
     s.add_dependency(%q<sinatra>, [">= 1.0.0"])
     s.add_dependency(%q<bson_ext>, [">= 0"])
     s.add_dependency(%q<haml>, [">= 3.0.24"])
     s.add_dependency(%q<sass>, [">= 3.0.0"])
-    s.add_dependency(%q<mongoid>, [">= 0"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
     s.add_dependency(%q<gravtastic>, [">= 0"])
     s.add_dependency(%q<shoulda>, ["= 2.10.3"])
     s.add_dependency(%q<rack-test>, [">= 0.5.6"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
   end
 end
 

data/test/helper.rb

@@ -1,17 +1,23 @@
+ENV['RACK_ENV'] = 'test'
 require 'rubygems'
 require 'bundler'
 Bundler.require
 require 'test/unit'
 require 'shoulda'
+require 'rack/test'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'punchcard'
 
-Punchcard.set :mongo_db, 'punchcard_test'
+# DB setup
+require 'logger'
+system 'rm ./punchcard_test.sqlite3'
+ActiveRecord::Migrator.migrate(File.join(File.dirname(__FILE__), "../lib/db/migrate"))
 
 class Test::Unit::TestCase
   def setup
     Person.delete_all
+    Punch.delete_all
   end
 end

data/test/test_database.rb

@@ -21,19 +21,22 @@ class TestDatabase < Test::Unit::TestCase
       assert_nil @person.pending?
     end
     
-    context "that gets punched" do
+    context "that got punched 2 hours ago" do
       setup do
         assert @person.punch!.instance_of?(Punch), "Should have been able to get punched and have returned a Punch"
+        punch = @person.pending?
+        punch.checked_in_at = 2.hours.ago
+        punch.save!
       end
       
       should "have one pending punch" do
         assert_equal Punch, @person.pending?.class
-        assert_equal 1, @person.punches.pending.length
-        assert_equal 0, @person.punches.finished.length
+        assert_equal 1, @person.punches.pending.count
+        assert_equal 0, @person.punches.finished.count
       end
       
       should "not allow to create another pending punch" do
-        assert_raise Mongoid::Errors::Validations do
+        assert_raise ActiveRecord::RecordInvalid do
           @person.punches.create!
         end
       end
@@ -53,8 +56,8 @@ class TestDatabase < Test::Unit::TestCase
         
         should "have one punch and no pending punches" do
           assert_equal 1, @person.punches.count
-          assert_equal 0, @person.punches.pending.length
-          assert_equal 1, @person.punches.finished.length
+          assert_equal 0, @person.punches.pending.count
+          assert_equal 1, @person.punches.finished.count
         end
         
         context "and gets punched yet again" do
@@ -68,17 +71,19 @@ class TestDatabase < Test::Unit::TestCase
           
           should "have 1 punch by having reopened the old one" do
             assert_equal 1, @person.punches.count
-            assert_equal 1, @person.punches.pending.length
-            assert_equal 0, @person.punches.finished.length
+            assert_equal 1, @person.punches.pending.count
+            assert_equal 0, @person.punches.finished.count
           end
         end
         
         context "and gets punched yet again 2 hours later" do
           setup do
             # Fake the timestamp so reopening does not get triggered
-            punch = @person.punches.first
+            punch = @person.punches.finished.first
+            punch.checked_in_at = 3.hours.ago
             punch.checked_out_at = 2.hours.ago
             punch.save!
+            assert_nil @person.pending?
             assert @person.punch!.instance_of?(Punch), "Should have been able to get punched and have returned a Punch"
           end
           
@@ -88,13 +93,33 @@ class TestDatabase < Test::Unit::TestCase
 
           should "have 2 punches and one pending punch" do
             assert_equal 2, @person.punches.count
-            assert_equal 1, @person.punches.pending.length
-            assert_equal 1, @person.punches.finished.length
+            assert_equal 1, @person.punches.pending.count
+            assert_equal 1, @person.punches.finished.count
           end
         end
       end
     end
     
+    context "that punched in just now" do
+      setup do
+        @person.punch!
+      end
+      
+      should "be punched in" do
+        assert @person.pending?
+      end
+      
+      context "and punches out shortly after that" do
+        setup do
+          @person.punch!
+        end
+        
+        should "not have any punches because of the automatic deletion of too-short punches" do
+          assert_equal 0, @person.punches.count
+        end
+      end
+    end
+    
     context "that punched in yesterday" do
       setup do
         @person.punch!

data/test/test_punchcard.rb

@@ -1,4 +1,5 @@
 require 'helper'
 
 class TestPunchcard < Test::Unit::TestCase
+  # TODO
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Christoph Olszowka
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-08 00:00:00 +01:00
+date: 2010-12-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,16 +76,18 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: mongoid
+  name: activerecord
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
+        - 3
         - 0
-        version: "0"
+        - 0
+        version: 3.0.0
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -131,7 +133,20 @@ dependencies:
         version: 0.5.6
   type: :development
   version_requirements: *id008
-description: Simple sinatra/mongodb app for tracking time when people have been in the office
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+description: Simple sinatra/activerecord based app for tracking time when people have been in the office
 email: christoph at olszowka de
 executables: []
 
@@ -150,12 +165,15 @@ files:
 - Rakefile
 - VERSION
 - config.ru
+- lib/db/migrate/01_create_people.rb
+- lib/db/migrate/02_create_punches.rb
 - lib/public/cardbg.png
 - lib/public/css/blueprint.css
 - lib/public/js/app.js
 - lib/punchcard.rb
 - lib/punchcard/person.rb
 - lib/punchcard/punch.rb
+- lib/punchcard/tasks.rb
 - lib/views/index.haml
 - lib/views/layout.haml
 - lib/views/screen.sass
@@ -194,7 +212,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Simple sinatra/mongodb app for tracking time when people have been in the office
+summary: Simple sinatra/activerecord based app for tracking time when people have been in the office
 test_files: 
 - test/helper.rb
 - test/test_database.rb