activr 1.0.0

data/lib/activr/timeline/route.rb

@@ -0,0 +1,161 @@
+#
+# A timeline route describes how an activity is routed to a timeline
+#
+class Activr::Timeline::Route
+
+  # @return [Class] timeline class
+  attr_reader :timeline_class
+
+  # @return [Class] activity class
+  attr_reader :activity_class
+
+  # @return [Hash] route settings
+  attr_reader :settings
+
+
+  class << self
+
+    # Get route kind
+    #
+    # @param routing_kind  [String] Routing kind
+    # @param activity_kind [String] Activity kind
+    # @return [String] Route kind
+    def kind_for_routing_and_activity(routing_kind, activity_kind)
+      "#{routing_kind}_#{activity_kind}"
+    end
+
+  end # class << self
+
+
+  # @param timeline_class [Class] Timeline class
+  # @param activity_class [Class] Activity class
+  # @param settings       [Hash] Route settings
+  # @option settings [Symbol] :using Predefined routing kind
+  # @option settings [Symbol] :to    Routing path
+  # @option settings [Symbol] :kind  Manually specified routing kind
+  def initialize(timeline_class, activity_class, settings)
+    @timeline_class = timeline_class
+    @activity_class = activity_class
+    @settings       = settings
+  end
+
+  # Get route kind
+  #
+  # @return [String] Route kind
+  def kind
+    @kind ||= self.class.kind_for_routing_and_activity(self.routing_kind, self.activity_class.kind)
+  end
+
+  # Get routing kind
+  #
+  # @return [String] Routing kind
+  def routing_kind
+    @routing_kind ||= (self.settings[:kind] && self.settings[:kind].to_s) || begin
+      if self.settings[:using] && self.settings[:to]
+        raise "Several routing kinds specified for #{self.activity_class}: #{self.settings.inspect}"
+      end
+
+      if self.settings[:using].blank? && self.settings[:to].blank?
+        raise "Missing routing for #{self.activity_class}: #{self.settings.inspect}"
+      end
+
+      result = self.settings[:using]
+      if result.blank?
+        result = if self.settings[:to].is_a?(Symbol)
+          self.settings[:to]
+        else
+          self.settings[:to].to_s.underscore.gsub('.', '_').to_sym
+        end
+      end
+
+      result.to_s
+    end
+  end
+
+  # Resolve recipients for given activity
+  #
+  # @param activity [Activity] Activity to resolve
+  # @return [Array<Object>] Array of recipients instances and/or ids
+  def resolve(activity)
+    recipients = if self.settings[:using]
+      self.resolve_using_method(self.settings[:using], activity)
+    elsif self.settings[:to]
+      self.resolve_to_path(self.settings[:to], activity)
+    else
+      raise "Don't know how to resolve recipients: #{self.settings}"
+    end
+
+    recipients = [ recipients ] unless recipients.is_a?(Array)
+    recipients.compact!
+
+    # check recipients
+    bad_recipient = recipients.find{ |recipient| !self.timeline_class.valid_recipient?(recipient) }
+    if bad_recipient
+      raise "Invalid recipient resolved by route #{self.inspect}: #{bad_recipient.inspect}"
+    end
+
+    recipients
+  end
+
+  # Resolve route using method call
+  #
+  # @api private
+  #
+  # @param meth     [Symbol]   Method to call on timeline class
+  # @param activity [Activity] Activity to resolve
+  # @return [Array<Object>] Array of recipients instances and/or ids
+  def resolve_using_method(meth, activity)
+    # send method
+    self.apply_meth(self.timeline_class, meth, activity)
+  end
+
+  # Resolve route using path
+  #
+  # @api private
+  #
+  # @param path     [String]   Path on activity
+  # @param activity [Activity] Activity to resolve
+  # @return [Array<Object>] Array of recipients instances and/or ids
+  def resolve_to_path(path, activity)
+    receivers = [ activity ]
+
+    meth_ary = path.to_s.split('.')
+    meth_ary.map(&:to_sym).each do |meth|
+      receivers = receivers.map do |receiver|
+        if !receiver.respond_to?(meth)
+          raise "Can't resolve routing path: receiver does not respond to method '#{meth}': #{receiver.inspect}"
+        end
+
+        # send method
+        self.apply_meth(receiver, meth, activity)
+      end.flatten.compact
+    end
+
+    receivers
+  end
+
+
+  #
+  # Private
+  #
+
+  # Apply a method on receiver, with given activity as parameter if receiver arity permits it
+  #
+  # @api private
+  #
+  # @param receiver [Object]   Receiver
+  # @param meth     [Symbol]   Method to call
+  # @param activity [Activity] Activity to provide in method call
+  # @return [Object] Result of method call on receiver
+  def apply_meth(receiver, meth, activity)
+    case receiver.method(meth).arity
+    when 2
+      receiver.__send__(meth, activity, self.timeline_class)
+    when 1
+      receiver.__send__(meth, activity)
+    else
+      receiver.__send__(meth)
+    end
+  end
+
+end # class Activr::Timeline::Route

data/lib/activr/utils.rb

@@ -0,0 +1,74 @@
+module Activr
+
+  # Utilities methods
+  class Utils
+
+    class << self
+
+      # Returns kind for given class
+      #
+      # @api private
+      #
+      # @param klass [Class] Class
+      # @param suffix [String] Expected suffix
+      # @return [String] Kind
+      def kind_for_class(klass, suffix = nil)
+        class_name = klass.to_s.split('::').last.underscore
+        if suffix && (match_data = class_name.match(/(.+)_#{suffix}$/))
+          match_data[1]
+        else
+          class_name
+        end
+      end
+
+      # Returns class for given kind
+      #
+      # @api private
+      #
+      # @param kind [String] Kind
+      # @param suffix [String] Suffix
+      # @return [Class] Class
+      def class_for_kind(kind, suffix = nil)
+        str = suffix ? "#{kind}_#{suffix}" : kind
+        str.camelize.constantize
+      end
+
+
+      #
+      # Mustache rendering
+      #
+
+      # Get a compiled mustache template
+      #
+      # @api private
+      #
+      # @param tpl [String] Template
+      # @return [String] Compiled template
+      def compiled_mustache_template(tpl)
+        @compiled_mustache_templates ||= {}
+        @compiled_mustache_templates[tpl] ||= begin
+          view = Mustache.new
+          view.raise_on_context_miss = true
+          view.template = tpl # will compile and store template once for all
+          view
+        end
+      end
+
+      # Render a mustache template
+      #
+      # @api private
+      #
+      # @param text     [String] Template to render
+      # @param bindings [Hash] Template bindings
+      # @return [String] Rendered template
+      def render_mustache(text, bindings)
+        tpl = self.compiled_mustache_template(text)
+        tpl.raise_on_context_miss = true
+        tpl.render(bindings)
+      end
+
+    end # class << self
+
+  end # class Utils
+
+end # module Activr

data/lib/activr/version.rb

@@ -0,0 +1,6 @@
+module Activr
+
+  # Activr version
+  VERSION = '1.0.0'
+
+end

data/lib/generators/activr/activity_generator.rb

@@ -0,0 +1,91 @@
+module Activr
+  # Rails generators
+  module Generators
+
+    # Generates an {Activity} subclass in your Rails application
+    class ActivityGenerator < ::Rails::Generators::NamedBase
+      # Default entity humanization method
+      DEFAULT_ENTITY_FIELD = :name
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      check_class_collision :suffix => "Activity"
+
+      argument :entities, :type => :array, :default => [], :banner => "entity[:class] entity[:class]"
+      class_option :full, type: :boolean, :desc => "Generate full class"
+
+      desc "Creates an Activity class"
+
+      # Create the activity class file
+      #
+      # @api private
+      def create_activity_file
+        template "activity.rb", "#{Activr.config.app_path}/activities/#{file_name}_activity.rb"
+      end
+
+      # Compute entities infos
+      #
+      # @api private
+      def entities_infos
+        entities.map do |str|
+          ary = str.split(':')
+
+          name = ary[0].underscore
+
+          klass, set_klass = if ary[1]
+            [ ary[1].camelize, true ]
+          else
+            [ ary[0].camelize, false ]
+          end
+
+          human_meth = _resolve_entity_field(klass)
+
+          result = {
+            :name     => name,
+            :humanize => human_meth,
+          }
+
+          result[:class] = klass if set_klass
+
+          result
+        end
+      end
+
+      # Generates a default humanization template
+      #
+      # @api private
+      def humanization
+        result = ""
+
+        actor = entities_infos.find{ |entity| entity[:name] == 'actor' }
+        if actor
+          result += "{{actor}} "
+        end
+
+        result += name.underscore.gsub('_', ' ')
+
+        entities_infos.each do |entity|
+          if entity[:name] != 'actor'
+            result += " {{{#{entity[:name]}}}}"
+          end
+        end
+
+        result
+      end
+
+      private
+
+      # @api private
+      def _resolve_entity_field(entity_klass)
+        klass = entity_klass.constantize
+
+        field = [ :fullname, :name, :title ].find do |meth_name|
+          klass.method_defined?(meth_name)
+        end
+
+        field || DEFAULT_ENTITY_FIELD
+      end
+    end
+
+  end
+end

data/lib/generators/activr/templates/activity.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+class <%= class_name %>Activity < Activr::Activity
+<% if entities_infos.blank? %>
+  # entity :actor, :class => User, :humanize => :fullname
+  # entity :buddy, :class => User, :humanize => :fullname
+
+  # humanize "{{{actor}}} is now following {{{buddy}}}"
+<% else %>
+<% entities_infos.each do |entity| -%>
+  entity :<%= entity[:name] %><% if entity[:class] %>, :class => <%= entity[:class] %><% end %>, :humanize => :<%= entity[:humanize] %>
+<% end -%>
+
+  humanize "<%= humanization %>"
+<% end %><% if options[:full] %>
+  #
+  # callbacks
+  #
+
+  # activity is stored in main collection
+  # before_store :check_stuff
+  # after_store :notify_stuff
+
+  # activity is routed to all timelines
+  # before_route :check_stuff
+  # after_route :notify_stuff
+<% end %>
+end

data/lib/generators/activr/templates/timeline.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+class <%= class_name %>Timeline < Activr::Timeline
+
+  recipient <%= recipient_class %>
+
+
+  #
+  # Routes
+  #
+
+  # route FollowBuddyActivity, :to => 'buddy', :humanize => "{{{actor}}} is now following you"
+
+
+  #
+  # Callbacks
+  #
+
+  # def self.should_route_activity?(activity)
+  #   # return `false` to cancel activity routing
+  #   true
+  # end
+  #
+  # def should_handle_activity?(activity, route)
+  #   # return `false` to skip routed activity
+  #   true
+  # end
+  #
+  # def should_store_timeline_entry?(timeline_entry)
+  #   # return `false` to cancel timeline entry storing
+  #   true
+  # end
+  #
+  # def will_store_timeline_entry(timeline_entry)
+  #   # this is your last chance to modify timeline entry before it is stored
+  # end
+  #
+  # def did_store_timeline_entry(timeline_entry)
+  #   # the timeline entry was stored, you can now do some post-processing
+  # end
+
+end

data/lib/generators/activr/timeline_generator.rb

@@ -0,0 +1,24 @@
+module Activr
+  # Rails generators
+  module Generators
+
+    # Generates a {Timeline} subclass in your Rails application
+    class TimelineGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      check_class_collision :suffix => "Timeline"
+
+      desc "Creates a Timeline class"
+      # class_option :recipient, :required => true, :type => :string, :desc => "Recipient class"
+      argument :recipient_class, :type => :string
+
+      # Create the timeline class file
+      #
+      # @api private
+      def create_timeline_files
+        template "timeline.rb", "#{Activr.config.app_path}/timelines/#{file_name}_timeline.rb"
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: activr
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aymerick JEHANNE
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fwissr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: delorean
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+    Activity Streams system by Fotonauts.
+email:
+- aymerick@fotonauts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- Rakefile
+- README.md
+- lib/activr/activity.rb
+- lib/activr/async/resque.rb
+- lib/activr/async.rb
+- lib/activr/configuration.rb
+- lib/activr/dispatcher.rb
+- lib/activr/entity/model_mixin.rb
+- lib/activr/entity.rb
+- lib/activr/rails_ctx.rb
+- lib/activr/railtie.rb
+- lib/activr/railties/activr.rake
+- lib/activr/registry.rb
+- lib/activr/storage/mongo_driver.rb
+- lib/activr/storage.rb
+- lib/activr/timeline/entry.rb
+- lib/activr/timeline/route.rb
+- lib/activr/timeline.rb
+- lib/activr/utils.rb
+- lib/activr/version.rb
+- lib/activr.rb
+- lib/generators/activr/activity_generator.rb
+- lib/generators/activr/templates/activity.rb
+- lib/generators/activr/templates/timeline.rb
+- lib/generators/activr/timeline_generator.rb
+homepage: https://github.com/fotonauts/activr
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Activr
+test_files: []
+has_rdoc: