katsudo 0.0.1 → 0.0.2

data/README.md

@@ -18,7 +18,66 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First create model by hand: STI and Polymorphic
+
+    $ rails generate model Activity type:string resource_type:string resource_id:integer user_type:string user_id:integer
+    $ rake db:migrate
+
+Now define any users models to be a subject of activity:
+
+    class User < ActiveRecord::Base
+      activity_user!
+    end
+
+    class Admin < ActiveRecord::Base
+      activity_user!
+    end
+
+Controller:
+
+    # application_controller.rb:
+   
+    def activity_user
+      current_admin||current_user # an accessor to current activity subject. I use Devise and all helpers built in.
+    end
+
+    # common controller action:
+
+    def create
+      respond_to do |format|
+        if @comment.save
+          flash << activity_message(:create_object, @comment)
+          format.html { redirect_to [@article, @comment] }
+        else
+          format.html { render action: "new" }
+        end
+      end
+    end
+  
+Model:
+
+    class CreateObject < Activity
+      def title
+        "Saved!"
+      end
+
+      def message
+        "#{resource.class.model_name.human} was created"
+      end
+    end
+
+Partial for activity:
+
+    # views/activities/create_object.html.erb
+
+    <strong><%= create_object.title %></strong>
+    <p><%= create_object.message %></p>
+
+If you want store each activity, add in controller as any filter:
+
+    trace_activity :only => [:create, :update, :destroy]
+
+
 
 ## Contributing
 

data/lib/katsudo/dispatch.rb

@@ -1,9 +1,8 @@
 require "katsudo/dispatch/controller_extension"
-require "katsudo/dispatch/flash_messages"
+require "katsudo/dispatch/flash_stack"
 
 module Katsudo
   module Dispatch      
-    ActionDispatch::Flash::FlashHash.send(:include, FlashExtension)
-    ActionDispatch::Flash::FlashNow.send(:include, FlashExtension)
+    ActionDispatch::Flash::FlashHash.send(:include, FlashHashExtension)
   end
 end

data/lib/katsudo/dispatch/controller_extension.rb

@@ -19,9 +19,6 @@ module Katsudo
 
         included do
           helper_method :#{name}, :#{activity_user}
-          if Rails.version >= "4.0.0"
-            add_flash_types(:messages)
-          end
         end
 
         module ClassMethods
@@ -55,7 +52,8 @@ module Katsudo
         end
 
         def #{name}_message(*args)
-          render_to_string(#{name}(*args)).html_safe
+          activity = #{name}(*args)
+          {activity.flash_key => render_to_string(activity)}
         end
 
         def last_#{name}

data/lib/katsudo/dispatch/flash_stack.rb

@@ -0,0 +1,57 @@
+module Katsudo
+  module Dispatch
+    
+    class FlashStack
+      def initialize(flash)
+        @flash = flash
+        @stack = {}
+      end
+
+      def []=(k,v)
+        @stack[k] = Array(v)
+      end
+
+      def [](k)
+        @stack[k] ||= []
+      end
+      
+      def method_missing(*args, &block)
+        @stack.send(*args, &block)
+      end
+      
+      def use
+        @stack.dup.tap do
+          @stack.clear
+        end
+      end
+      
+    end
+    
+    module FlashHashExtension
+      extend ActiveSupport::Concern
+      
+      included do
+        class_eval do
+          def empty?
+            @flashes.empty? && (@stack.nil? ? true : @stack.empty?)
+          end
+        end
+      end
+      
+      def <<(*hashes)
+        hashes.each do |hash|
+          hash.each do |k,v|
+            Array(v).each do |value|
+              stack[k] << value
+            end
+          end
+        end
+      end
+      
+      def stack
+        @stack ||= FlashStack.new(self)
+      end
+    end
+    
+  end
+end

data/lib/katsudo/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: katsudo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 00:00:00.000000000 Z
+date: 2013-01-05 00:00:00.000000000 Z
 dependencies: []
 description: User activity for Rails
 email:
@@ -29,7 +29,7 @@ files:
 - lib/katsudo/configuration.rb
 - lib/katsudo/dispatch.rb
 - lib/katsudo/dispatch/controller_extension.rb
-- lib/katsudo/dispatch/flash_messages.rb
+- lib/katsudo/dispatch/flash_stack.rb
 - lib/katsudo/engine.rb
 - lib/katsudo/models.rb
 - lib/katsudo/models/activity.rb

data/lib/katsudo/dispatch/flash_messages.rb

@@ -1,44 +0,0 @@
-module Katsudo
-  module Dispatch
-    
-    class Messages
-      class Item
-        attr_accessor :type, :text
-        def initialize(type, text)
-          @type = type.to_sym
-          @text = text.to_s
-        end
-        
-        def inspect
-          @text
-        end
-      end
-      
-      attr_reader :scope
-      delegate :any?, :many?, :present?, :each, :map, :collect, :group_by, :to => :scope
-      
-      def initialize
-        @scope = []
-      end
-
-      def add(type, text)
-        @scope << Item.new(type, text)
-      end
-      
-      def grouped
-        group_by(&:type)
-      end
-      
-    end
-    
-    module FlashExtension
-      extend ActiveSupport::Concern
-      
-      def messages
-        self[:messages] ||= Messages.new
-      end
-      
-    end
-    
-  end
-end