userstamp_basic 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 bokmann
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,37 @@
+= userstamp_basic
+
+Rails provides some really nice helpers for adding date/time stamps to your models...  wouldn't it be nice if it could do the same for setting updated_by and created_by for the current user?  It can!  Here it is.
+
+1. Include the gem
+2. in your model's migration just add a line like:
+     t.userstamps
+   paralling the way timestamps work.
+3. In your model just declare 'stampable' someplace.
+
+Oh - you'll also need the sentient_user gem.
+
+== What's wrong with DeLynn Berry's UserStamp?
+http://github.com/delynn/userstamp
+
+Not a thing!  I have used it for a while and like it a lot.  I just wanted a few things, namely:
+1. Reliance on the sentient_user gem, so that ugliness is pulled into one place.
+2. Simplified code.  The original UserStamp has grown to support two different modes, the ability to make any class the 'stampable' class, etc.  If you need all that, great!  But if you don't, its a lot of mental overhead to deal with.  This stripped down version offers a lot less functionality but with a lot less meta and the ability to wrap your head around it all in a few minutes.
+
+== ToDo
+This needs some testing.  It has tests in the project I just pulled it out of, but now it needs its own little internal rails project to give it its own test coverage (see the original UserStamp or my own StonePath library to see how to do this).  I'll get to it, but not as part of my day-job.  If you want to contribute, I'm accepting patches.
+
+There is specifically no new functionality on this todo list.  If you want more functionality, use DeLynn's UserStamp above.  This exists solely for the value of the simplicity it provides.  Without that simplicity, this gem provides no value.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 bokmann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "userstamp_basic"
+    gem.summary = %Q{A simplified version of UserStamp}
+    gem.description = %Q{Provides a simple userstamp to models... automatically updates created_by and updated_by based on the current user.}
+    gem.email = "dbock@codesherpas.com"
+    gem.homepage = "http://github.com/bokmann/userstamp_basic"
+    gem.authors = ["bokmann"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency('sentient_user','>= 0.1.0')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "userstamp_basic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/migration_helper.rb

@@ -0,0 +1,18 @@
+module Sherpa
+  module UserstampBasic
+    module MigrationHelper
+      def self.included(base) # :nodoc:
+        base.send(:include, InstanceMethods)
+      end
+
+      module InstanceMethods
+        def userstamps
+          puts "creating userstamps"
+          column(:created_by_id, :integer)
+          column(:updated_by_id, :integer)
+        end
+      end
+    end
+  end
+end
+ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, Sherpa::UserstampBasic::MigrationHelper)

data/lib/stampable.rb

@@ -0,0 +1,34 @@
+module Sherpa #:nodoc:
+  module UserstampBasic
+    module Stampable
+      def self.included(base) #:nodoc:
+        base.extend(ClassMethods)
+        base.class_eval do
+          include InstanceMethods
+          #self.stampable
+        end
+      end
+    end
+    module ClassMethods
+      def stampable
+        class_eval do
+          before_save :set_updated_by
+          before_create :set_created_by
+          belongs_to :created_by, :class_name => "User"
+          belongs_to :updated_by, :class_name => "User"
+        end
+      end
+    end
+    
+    module InstanceMethods
+      def set_updated_by
+        self.updated_by = User.current
+      end
+      
+      def set_created_by
+        self.created_by = User.current
+      end
+    end
+  end
+end
+ActiveRecord::Base.send(:include, Sherpa::UserstampBasic::Stampable) if defined?(ActiveRecord)

data/lib/userstamp_basic.rb

@@ -0,0 +1,2 @@
+require 'migration_helper'
+require 'stampable'

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'userstamp_basic'
+
+class Test::Unit::TestCase
+end

data/test/test_userstamp_basic.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestUserstampBasic < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: userstamp_basic
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- bokmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sentient_user
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+    version: 
+description: Provides a simple userstamp to models... automatically updates created_by and updated_by based on the current user.
+email: dbock@codesherpas.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/migration_helper.rb
+- lib/stampable.rb
+- lib/userstamp_basic.rb
+- test/helper.rb
+- test/test_userstamp_basic.rb
+has_rdoc: true
+homepage: http://github.com/bokmann/userstamp_basic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simplified version of UserStamp
+test_files: 
+- test/helper.rb
+- test/test_userstamp_basic.rb