satchel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f65129ed73d372a2b29b8c7bdabdf65f21616502
-  data.tar.gz: baa20abc0389eb97ef188b676c70073049931fed
+  metadata.gz: e58681014e253497e9642f2c4c8e91061ede86bb
+  data.tar.gz: 3133bb65293a8948260731a24df60f989f835e39
 SHA512:
-  metadata.gz: 2a947c6b478508e3d46f076b64b32e3cdce44c8830760f15e7347fccdb52855746047cbe0c30bddf9bc1c7e3c0d725881d6adde0e4f489a6a8441c1634a4e08d
-  data.tar.gz: 9d937162e3a863a63752c7ab7d286048e7ff4f4061d2cba53cec58bb34f5f22f31bd3208abf44e7a24596069900bf62bfeacbf0667b0a3a9e725f002129f4491
+  metadata.gz: 46e3ceb68cec34a77ceb26068c83ecaeacd40d84d6281be1f25877d8c2a6f140c67e9e00dcfbdb3f0d3ecf1713ebab51acdbeae861290bdea0a555ec4ccc761b
+  data.tar.gz: 0e9ddfc8541a8e7dc28d90eb658798efbb96aa4543fc9b8d0ffb33dce70210ea91cf66657c62b19628173906abb1f7257deed6d4f296a5bd105848b8d32a4e28

data/.gitignore

@@ -6,4 +6,5 @@ spec/dummy/log/*.log
 spec/dummy/tmp/
 spec/dummy/.sass-cache
 Gemfile.lock
-tmp/*
+tmp/*
+coverage/

data/README.md

@@ -2,3 +2,38 @@
 
 A mountable Rails engine for both recording activity and displaying activity on
 a persisted object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'satchel'
+
+And then execute:
+
+    $ bundle
+
+Then run:
+
+    $ rails g satchel:install
+
+## Register a Method
+
+To record activity, register a class and method via a Rails generator.
+
+    $ rails g satchel:register <ClassName> <MethodName> <Subject>
+
+Or by hand in a config/initializers/satchel_config.rb
+
+    Satchel.register('<ClassName>', '<MethodName>') do |activity,context|
+      activity.subject = context.<subject>
+      activity.user = context.current_user
+      activity.activity_type = "an arbitrary type"
+      activity.message = "A particulare message?"
+    end
+
+Then, whenever the ClassName#MethodName is invoke an activity will be recorded.
+
+## TODO
+
+* Provide a means for retrieving an object's activities

data/lib/generators/satchel/install_generator.rb

@@ -0,0 +1,19 @@
+module Satchel
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates a Satchel initializer."
+
+      def copy_initializer
+        template "satchel_config.rb", "config/initializers/satchel_config.rb"
+      end
+
+      def run_migrations
+        rake('satchel:install:migrations')
+        rake('db:migrate')
+      end
+
+    end
+  end
+end

data/lib/generators/satchel/register_generator.rb

@@ -0,0 +1,28 @@
+module Satchel
+  module Generators
+    class RegisterGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates a Satchel initializer."
+      argument :class_name, type: :string
+      argument :method_name, type: :string
+      argument :subject_method, type: :string
+
+      def copy_initializer
+        generate('satchel:install')
+        text = [
+          "Satchel.register('#{class_name}', '#{method_name}') do |activity, context|",
+          "  activity.subject = context.#{subject_method}",
+          "  activity.user = context.current_user",
+          "  activity.activity_type = '#{class_name}##{method_name}'",
+          "#  activity.message = 'Specify a custom message if applicable'",
+          "end",
+          "",
+          ""
+        ].join("\n")
+
+        inject_into_file('config/initializers/satchel_config.rb', text, before: /\A.*Satchel.register/)
+      end
+    end
+  end
+end

data/lib/generators/satchel/templates/satchel_config.rb

@@ -0,0 +1,6 @@
+# Satchel.register('PagesController', 'show') do |activity,context|
+#   activity.subject = context.page
+#   activity.user = context.current_user
+#   activity.activity_type = 'pages#show'
+#   activity.message = "A particulare message?"
+# end

data/lib/satchel/version.rb

@@ -1,3 +1,3 @@
 module Satchel
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/spec_helper.rb

@@ -1,5 +1,14 @@
 ENV["RAILS_ENV"] ||= 'test'
 
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.command_name "spec"
+  SimpleCov.start 'rails' do
+    add_filter '/spec'
+  end
+end
+
+
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require File.expand_path('../spec_patch', __FILE__)
 require "rails/test_help"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: satchel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -76,6 +76,9 @@ files:
 - app/views/layouts/satchel/application.html.erb
 - config/routes.rb
 - db/migrate/20130722162331_create_satchel_activities.rb
+- lib/generators/satchel/install_generator.rb
+- lib/generators/satchel/register_generator.rb
+- lib/generators/satchel/templates/satchel_config.rb
 - lib/satchel.rb
 - lib/satchel/activity_builder.rb
 - lib/satchel/activity_data_structure.rb