honesty 0.0.7 → 0.3.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Tim Boisvert
+
+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,65 @@
+Honesty
+=================
+
+Honesty allows developers to store and track user activities and system events in 
+a human-readable, easily-searchable format.
+
+== Resources
+
+Install
+
+* gem install honesty
+* If using bundler:
+** Add "gem 'honesty'" to your Gemfile
+** "bundle install"
+
+ 
+Generate the model:
+
+** Rails 3: rails g honesty
+** Rails 2: script/generate honesty
+
+Migrate:
+** rake db:migrate
+
+== Usage
+ 
+ * use Honesty in your ActiveRecord model.
+ 
+ class Shoe < ActiveRecord::Base
+ 	honesty
+ end
+ 
+ * Add a fact to a model instance
+ 
+ Parameters:
+ * Context - the object being acted on or the entity being tracked.
+ * Agent - the actor, so to speak.
+ * Action - the action taking place.
+
+ shoe = Shoe.create
+ shoe.fact("Shoe", "Tim Boisvert", "Created Adidas Superstar II")
+
+ * If you want to short-cut the fact and use the object's class name as the context:
+
+ shoe = Shoe.create
+ shoe.fact("Tim Boisvert", "Created Adidas Superstar II")
+
+ In this case the context would've been set to the class name of the object calling it -- in this case, Shoe 
+
+ * Get facts:
+ 
+ shoe = Shoe.find(1)
+ facts = shoe.facts.all
+
+== Credits
+
+This plugin is heavily influenced by Acts As Taggable. Thanks to Jack Dempsey et al.
+
+== Contributors
+
+Tim Boisvert
+
+== More
+
+http://github.com/timboisvert/honesty

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/install.rb

@@ -0,0 +1,2 @@
+puts "To create the honesty model please run:"
+puts "rails g honesty

data/lib/fact.rb

@@ -0,0 +1,7 @@
+module Honesty
+  # TODO
+  # including this module into your Fact model will give you finders and named scopes
+  # useful for working with Facts.
+  module Fact
+  end
+end

data/lib/generators/honesty/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Copies fact.rb to app/models/.
+    Copies create_facts.rb to db/migrate
+
+Examples:
+    `rails g honesty`

data/lib/generators/honesty/honesty_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/migration'
+
+class HonestyGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.expand_path("../templates", __FILE__)
+  end
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_model_file
+    template "fact.rb", "app/models/fact.rb"
+    migration_template "create_facts.rb", "db/migrate/create_facts.rb"
+  end
+end

data/lib/generators/honesty/templates/create_facts.rb

@@ -0,0 +1,18 @@
+class CreateFacts < ActiveRecord::Migration
+  def self.up
+    create_table :facts do |t|
+      t.string :context, :limit => 40 
+      t.string :agent
+      t.string :action
+      t.references :honest, :polymorphic => true
+      t.timestamps
+    end
+
+    add_index :facts, :honest_type
+    add_index :facts, :honest_id
+  end
+
+  def self.down
+    drop_table :facts
+  end
+end

data/lib/generators/honesty/templates/fact.rb

@@ -0,0 +1,10 @@
+class Fact < ActiveRecord::Base
+  #include Honesty::Fact
+  belongs_to :honest, :polymorphic => true
+  default_scope :order => 'created_at ASC'
+
+  # add the models this fact can belong to
+  # belongs_to :show
+  # belongs_to :user
+  # etc...
+end

data/lib/honesty.rb

@@ -1,51 +1,28 @@
-require "honesty/version"
 require 'active_record'
 
-#this is HEAVILY influenced by aprihodko's acts_as_reportable gem
-module ActiveRecord; module Acts; end; end
-module ActiveRecord::Acts::Honesty
+# Honesty
+module Honesty 
 
   def self.included(base)
-    base.extend ClassMethods
+    base.extend ClassMethods  
   end
-  
+
   module ClassMethods
     def honesty
-      has_many :truths, :as => :honesty, :dependent => :destroy, :order => 'created_at ASC'
-      include ActiveRecord::Acts::Honesty::InstanceMethods
+      has_many :facts, {:as => :honest, :dependent => :destroy}
+      include Honesty::InstanceMethods
     end
   end
-  
+
   module InstanceMethods
-    def truth(context, agent, action)
-      truth = self.truths.new
-      truth.context = context
-      truth.agent = agent
-      truth.action = action
-      truth.save!
-    end
-    
-    # Helper methods
-    def truths_by_context
-      Truth.find(:all,
-        :conditions => ["context = ?", self.class.context],
-        :order => "created_at DESC"
-      )
-    end
-    def truths_by_agent
-      Truth.find(:all,
-        :conditions => ["agent = ?", self.class.agent],
-        :order => "created_at DESC"
-      )
-    end
-    def truths_by_action
-      Truth.find(:all,
-        :conditions => ["action = ?", self.class.action],
-        :order => "created_at DESC"
-      )
-    end
+    def fact(*params)
+    	if params.length == 3
+	 		self.facts.create(:context => params[0], :agent => params[1], :action => params[2])
+	 	elsif params.length == 2
+	 		self.facts.create(:context => self.class.name, :agent => params[0], :action => params[1])
+		end
+	end
   end
-    
 end
 
-ActiveRecord::Base.send(:include, ActiveRecord::Acts::Honesty)
+ActiveRecord::Base.send(:include, Honesty)

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Honesty  
+  VERSION = "0.3.0"  
+end  

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: honesty
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
 - Tim Boisvert
-autorequire: 
+autorequire: honesty
 bindir: bin
 cert_chain: []
-date: 2012-01-24 00:00:00.000000000 Z
+date: 2012-01-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70196832908400 !ruby/object:Gem::Requirement
+  requirement: &14777840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196832908400
+  version_requirements: *14777840
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70196832906820 !ruby/object:Gem::Requirement
+  requirement: &14777140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,33 +32,39 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196832906820
+  version_requirements: *14777140
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70196832906180 !ruby/object:Gem::Requirement
+  requirement: &14776420 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70196832906180
+  version_requirements: *14776420
 description: Store and track user activities and system events in a human-readable,
-  easily-searchable format.
-email:
-- boisvert@gmail.com
+  easily-searchable format
+email: boisvert@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.rdoc
+- MIT-LICENSE
 files:
-- .gitignore
-- Gemfile
-- Rakefile
-- honesty.gemspec
+- MIT-LICENSE
+- README.rdoc
 - lib/honesty.rb
-- lib/honesty/version.rb
-homepage: ''
+- lib/fact.rb
+- lib/version.rb
+- lib/generators/honesty/honesty_generator.rb
+- lib/generators/honesty/templates/fact.rb
+- lib/generators/honesty/templates/create_facts.rb
+- lib/generators/honesty/USAGE
+- init.rb
+- install.rb
+homepage: http://github.com/timboisvert/honesty
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -77,9 +83,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: honesty
-rubygems_version: 1.8.12
+rubyforge_project: 
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Store and track human-readable user activities and system events
+summary: Store and track user activities and system events in a human-readable, easily-searchable
+  format
 test_files: []

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in honesty.gemspec
-gemspec

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/honesty.gemspec

@@ -1,25 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "honesty/version"
-
-Gem::Specification.new do |s|
-  s.name        = "honesty"
-  s.version     = Honesty::VERSION
-  s.authors     = ["Tim Boisvert"]
-  s.email       = ["boisvert@gmail.com"]
-  s.homepage    = ""
-  s.summary     = %q{Store and track human-readable user activities and system events}
-  s.description = %q{Store and track user activities and system events in a human-readable, easily-searchable format.}
-
-  s.rubyforge_project = "honesty"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  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_development_dependency 'sqlite3'
-  s.add_dependency 'rails', '~> 3.0'
-end

data/lib/honesty/version.rb

@@ -1,3 +0,0 @@
-module Honesty
-  VERSION = "0.0.7"
-end