canmoia 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e32b4b89e98944da5607f61c21ef58cf8b2ab1e5
+  data.tar.gz: 07f3260fddc77f8d5a45328a50a91fedce11290f
+SHA512:
+  metadata.gz: 6d0d92901045552b14bb859e4ff04936d006bae028bdd02ee15c8658607f9ea9db6e12b2fa6c965b45209eca322accd55ee4d3b7cde22acda36c658c7c2120bf
+  data.tar.gz: 13c93f718d7d5413eb7123e4a3f9f942cd953f27a1ee8ec39e6c7ca6cb4ee9707963eba80f5c45f616fa0620342371d4536415b3c8f378c1461c92b0e9870fca

data/Guardfile

@@ -0,0 +1,30 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Canmoia Concerns
+  watch(%r{^lib/canmoia/concerns(.+)\.rb$})                   { |m| ["spec/#{m[1]}_spec.rb", "spec/lib/concerns/#{m[1]}_spec.rb"] }
+  watch(%r{^lib/canmoia/features(.+)\.rb$})                   { |m| ["spec/#{m[1]}_spec.rb", "spec/lib/features/#{m[1]}_spec.rb"] }
+
+  # Fabricators
+  watch(%r{^spec/fabricators/(.+)\.rb$})              { |m| ["spec/#{m[1]}_spec.rb", "spec/concerns/#{m[1]}_spec.rb", "spec/models/#{m[1]}_spec.rb"] }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/README.md

@@ -0,0 +1,186 @@
+Canmöia
+=======
+
+<!---
+
+TODO Add badges of this services
+
+[![Travis](https://api.travis-ci.org/indefinido/canmoia.png)](http://travis-ci.org/indefinido/canmoia)
+[![Coverage Status](https://coveralls.io/repos/indefinido/canmoia/badge.png?branch=master)](https://coveralls.io/r/indefinido/canmoia)
+[![Code Climate](https://codeclimate.com/github/indefinido/canmoia.png)](https://codeclimate.com/github/indefinido/canmoia)
+![project status](http://stillmaintained.com/indefinido/canmoia.png)
+
+-->
+
+Summary
+-------
+
+Canmöia (can = order, möia = work, work order). The core functionality of the  [Order domain](http://en.wikipedia.org/wiki/Work_order)
+
+Requirements
+------------
+
+  - ruby 2.0.0
+  - workflow
+  - currently only support mongoid models
+
+Getting Started
+---------------
+
+Add to your Gemfile:
+
+```ruby
+gem 'canmoia'
+```
+
+You must have a **model named User** and a **model named Item** for this to
+work properly. Then add the concern you want to your model:
+
+```ruby
+class Order
+  include Mongoid::Document
+  include Canmoia::Order
+end
+```
+
+
+You now have a fully working Order:
+
+```ruby
+order = Order.new
+order.items << Item.new(value: 100)
+order.items << Item.new(value: 150)
+
+# Automatically computes total upon validation
+order.valid?
+order.total      # 250.00
+
+# Manage basic order states (workflow gem basics)
+# To override behaviour just define close! method on model
+order.close!
+order.closed?    # true
+
+order.accept!
+order.accepted?  # true
+order.state      # accepted
+
+
+# Automagically generated associations
+order.client    # your User model
+order.items      # your Item model
+```
+
+You might also try the Work Order concern:
+
+```ruby
+class Order
+  include Mongoid::Document
+  # Canmoia::Order is automatically included
+  include Canmoia::Work
+end
+
+# Automagically generated associations
+order.responsible
+
+# Autmatically notifications!
+# When closing a order:
+order.close!
+
+# Canmoia will automatically try to notify
+# the domain resposables for the event
+# Trigerring this methods:
+# OrderMailer.close_notification_to_responsible(order, order.responsible).deliver
+# OrderMailer.close_notification_to_client(order, order.client).deliver
+#
+# Generalizing:
+# #{YourModel}Mailer.#{event}_notification_to_#{recipient}
+
+```
+
+Documentation
+-------------
+
+Sometime on the future might be a wiki page
+
+### Concerns
+#### Order (Canmoia::Order)
+
+The current states and transitions are:
+<sup>Order will always start at opened state (italics)</sup>
+
+| state       | event    | transitions to |
+|:-----------:|:--------:|:--------------:|
+| *opened*    | close    | reviewing      |
+| *opened*    | cancel   | canceled       |
+| reviewing   | accept   | accepted       |
+| reviewing   | reject   | rejected       |
+| reviewing   | cancel   | canceled       |
+| accepted    | complete | completed      |
+| accepted    | cancel   | canceled       |
+| rejected    | complete | completed      |
+| rejected    | cancel   | canceled       |
+| completed   | -        | -              |
+| canceled    | -        | -              |
+
+
+#### Work Order (Canmoia::Work)
+
+
+You can specify to which events canmöia should send notifications:
+
+```ruby
+class Order
+  include Mongoid::Document
+  # Canmoia::Order is automatically included
+  include Canmoia::Work
+
+  # BTW this are the defaults!
+  notify :responsible, :on => [:open, :close]
+  notify :client     , :on => [:open, :accept, :reject, :cancel]
+end
+```
+### Features
+
+
+#### Notification (Canmoia::Notification)
+ Include workflow and rock with only notification functionalities!
+
+```ruby
+class Order
+  include Mongoid::Document
+  include Workflow
+  include Canmoia::Notification
+
+  workflow do
+
+    state :opened do
+        event :close, :transitions_to => :checkout
+    end
+
+    state :checkout
+
+  end
+
+  #  Remember, will trigger: OrderMailer.close_notification_to_responsible(order, order.responsible).deliver
+  notify :responsible, :on => :close
+end
+```
+
+
+TODO
+----
+
+### Mail Generator
+Automatically add default mail templates for notification kinds to the view_path
+
+### Purchase Order
+Add suport for Purchase Order Concern    (Canmoia::Purchasable)
+
+### Reviewable Feature
+Extract review order feature from Order concern (Canmoia::Reviewable)
+
+
+
+
+
+This project rocks and uses WTFP-LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Canmoia'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/WTFP-LICENSE

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/lib/canmoia/concerns/notification.rb~

@@ -0,0 +1,38 @@
+module Canmoia::Notification
+
+  def notify entity_name = :responsible, on: -> { raise "on is required" }, via: :email
+    raise "Recipient named as '#{entity_name}' not found for #{self.name}" unless instance_methods.include? entity_name.to_sym
+
+    on.each do |event|
+      add_notification_method event, entity_name, via
+    end
+  end
+
+  private
+
+  # TODO use method missing
+  def add_notification_method event, entity_name, via
+    mail_method = "#{event}_notification_to_#{entity_name}"
+
+    define_method "#{event}!" do |*args|
+      returned = super *args
+      # TODO better error message when mailer is not found
+      # TODO allow specification of custom mailer
+      mailer = "#{self.class.name}Mailer".classify.constantize
+
+      # TODO better error message when mail method is not found
+      entity = send entity_name
+      mail   = mailer.send mail_method, self, entity
+
+      mail.deliver or returned
+    end
+  end
+
+  # - on :open   , close: :reviewing, cancel: :canceled, notify: :responsible
+  # V on :review, reject: :rejected, accept: :accepted
+  # - on :accept, notify: :buyer
+  # - on :reject, notify: :buyer
+  # - on :cancel, notify: [:buyer, via: :email] }
+  # - on :finish, notify: [:buyer, via: :email] }
+
+end

data/lib/canmoia/concerns/order.rb

@@ -0,0 +1,71 @@
+require 'active_support/concern'
+
+module Canmoia
+  module Order
+    extend ActiveSupport::Concern
+
+    included do
+      include ::Workflow
+      include CalculationMethods
+      # extend  Notification
+
+      # Fields
+      # TODO move to Canmoia::Purchase
+      field :state, type: Symbol
+      field :total, type: Float
+
+      # Relations
+      embeds_many :items
+
+      # TODO move to Canmoia::Purchase
+      has_one :client, :class_name => "::User"
+
+      # Domain Callbacks
+      before_validation :calculate_total, :if => :opened?
+
+      # States
+      workflow_column :state
+      workflow do
+
+        state :opened do
+          event :close , transitions_to: :reviewing
+          event :cancel, transitions_to: :canceled
+        end
+
+        state :reviewing do
+          event :accept, transitions_to: :accepted
+          event :reject, transitions_to: :rejected
+
+          event :cancel, transitions_to: :canceled
+        end
+
+        state :accepted do
+          event :complete, transitions_to: :completed
+          event :cancel  , transitions_to: :canceled
+        end
+
+        state :rejected do
+          event :complete, transitions_to: :completed
+          event :cancel  , transitions_to: :canceled
+        end
+
+        state :completed
+        state :canceled
+      end
+    end
+
+    module CalculationMethods
+      def calculate_total
+        self.total = items.sum &:value
+      end
+    end
+
+    # - on :open   , close: :reviewing, cancel: :canceled, notify: :responsible
+    # V on :review, reject: :rejected, accept: :accepted
+    # - on :accept, notify: :buyer
+    # - on :reject, notify: :buyer
+    # - on :cancel, notify: [:buyer, via: :email] }
+    # - on :finish, notify: [:buyer, via: :email] }
+
+  end
+end

data/lib/canmoia/concerns/order.rb~

@@ -0,0 +1,65 @@
+require 'active_support/concern'
+
+module Canmoia
+  module Order
+    extend ActiveSupport::Concern
+
+    included do
+      include ::Workflow
+      include CalculationMethods
+      # extend  Notification
+
+      # Fields
+      field :total, type: Float
+      field :state, type: Symbol
+
+      # Relations
+      embeds_many :items
+      has_one :client, :class_name => "::User"
+
+      # States
+      workflow_column :state
+      workflow do
+
+        state :opened do
+          event :close , transitions_to: :reviewing
+          event :cancel, transitions_to: :canceled
+        end
+
+        state :reviewing do
+          event :accept, transitions_to: :accepted
+          event :reject, transitions_to: :rejected
+
+          event :cancel, transitions_to: :canceled
+        end
+
+        state :accepted do
+          event :complete, transitions_to: :completed
+          event :cancel  , transitions_to: :canceled
+        end
+
+        state :rejected do
+          event :complete, transitions_to: :completed
+          event :cancel  , transitions_to: :canceled
+        end
+
+        state :completed
+        state :canceled
+      end
+    end
+
+    module CalculationMethods
+      def total
+        @total ||= super or items.sum(&:value)
+      end
+    end
+
+    # - on :open   , close: :reviewing, cancel: :canceled, notify: :responsible
+    # V on :review, reject: :rejected, accept: :accepted
+    # - on :accept, notify: :buyer
+    # - on :reject, notify: :buyer
+    # - on :cancel, notify: [:buyer, via: :email] }
+    # - on :finish, notify: [:buyer, via: :email] }
+
+  end
+end

data/lib/canmoia/concerns/work.rb

@@ -0,0 +1,21 @@
+require 'active_support/concern'
+
+module Canmoia
+  module Work
+    extend ActiveSupport::Concern
+
+    included do
+      include Order
+      extend Notification
+
+      # Fields
+
+      # Relations
+      belongs_to :responsible, :class_name => "::User"
+
+      # States Notifications
+      notify :responsible, :on => [:open, :close]
+      notify :client     , :on => [:open, :accept, :reject, :cancel]
+    end
+  end
+end

data/lib/canmoia/concerns/work.rb~

@@ -0,0 +1,33 @@
+require 'active_support/concern'
+
+module Canmoia
+  module Work
+    extend ActiveSupport::Concern
+
+    included do
+      include Order
+
+      # Fields
+
+      # Relations
+      belongs_to :responsible, :class_name => "::User"
+
+      # States Notifications
+      notify :responsible
+    end
+
+    module CalculationMethods
+      def total
+        @total ||= items.sum(&:value)
+      end
+    end
+
+    # - on :open   , close: :reviewing, cancel: :canceled, notify: :responsible
+    # V on :review, reject: :rejected, accept: :accepted
+    # - on :accept, notify: :buyer
+    # - on :reject, notify: :buyer
+    # - on :cancel, notify: [:buyer, via: :email] }
+    # - on :finish, notify: [:buyer, via: :email] }
+
+  end
+end

data/lib/canmoia/features/notification.rb

@@ -0,0 +1,51 @@
+# require 'active_support/concern'
+
+module Canmoia
+  module Notification
+    # TODO add when needed extend ActiveSupport::Concern
+
+    attr_accessor :notifications_declared
+
+    def self.extended base
+      base.notifications_declared = []
+    end
+
+    def notify recipient_attribute = :responsible, on: -> { raise "on is required" }, via: :email
+      raise "Recipient named as '#{recipient_attribute}' not found for #{self.name}" unless instance_methods.include? recipient_attribute.to_sym
+
+      on.each do |event|
+        add_notification_method event, recipient_attribute, via
+      end
+    end
+
+    private
+
+    # TODO use method missing
+    def add_notification_method event, recipient_attribute, via
+      mail_method = "#{event}_notification_to_#{recipient_attribute}"
+
+      notification = "#{event}_#{recipient_attribute}".to_sym
+      unless notifications_declared.include? notification
+        notifications_declared << notification
+      else
+        raise "Notification for event '#{event}' to recipient '#{recipient_attribute}' already declared!"
+      end
+
+      # TODO only define notification method if method is present on mailer
+      # TODO create task to generate / update mailer with notification settings
+
+      define_method "#{event}!" do |*args|
+        returned = super *args
+        # TODO better error message when mailer is not found
+        # TODO allow specification of custom mailer
+        mailer = "#{self.class.name}Mailer".classify.constantize
+
+        # TODO better error message when mail method is not found
+        entity = send recipient_attribute
+        mail   = mailer.send mail_method, self, entity
+
+        mail.deliver or returned
+      end
+    end
+  end
+end

data/lib/canmoia/features/notification.rb~

@@ -0,0 +1,38 @@
+# require 'active_support/concern'
+
+module Canmoia
+  module Notification
+    # TODO add when needed extend ActiveSupport::Concern
+
+    def notify entity_name = :responsible, on: -> { raise "on is required" }, via: :email
+      raise "Recipient named as '#{entity_name}' not found for #{self.name}" unless instance_methods.include? entity_name.to_sym
+
+      on.each do |event|
+        add_notification_method event, entity_name, via
+      end
+    end
+
+    private
+
+    # TODO use method missing
+    def add_notification_method event, entity_name, via
+      mail_method = "#{event}_notification_to_#{entity_name}"
+
+      # TODO only define notification method if method is present on mailer
+      # TODO create task to generate / update mailer with notification settings
+
+      define_method "#{event}!" do |*args|
+        returned = super *args
+        # TODO better error message when mailer is not found
+        # TODO allow specification of custom mailer
+        mailer = "#{self.class.name}Mailer".classify.constantize
+
+        # TODO better error message when mail method is not found
+        entity = send entity_name
+        mail   = mailer.send mail_method, self, entity
+
+        mail.deliver or returned
+      end
+    end
+  end
+end

data/lib/canmoia/tasks/install.rb.erb

@@ -0,0 +1,23 @@
+module Canmoia
+  module Tasks
+    require 'rails/generators'
+
+    class Install < Rails::Generators::Base
+
+
+      # Sample installation task
+      # def copy_initializer_file
+      #  template 'canmoia.rb', 'config/initializers/canmoia.rb'
+      # end
+      
+      private
+      def self.add_templates_path!
+        current_directory = File.dirname(__FILE__)
+        source_paths << File.join(current_directory, 'templates')
+        source_paths << File.expand_path(File.join current_directory, '..', '..', '..')
+      end
+
+      add_templates_path!
+    end
+  end
+end

data/lib/canmoia/version.rb

@@ -0,0 +1,3 @@
+module Canmoia
+  VERSION = "0.0.1"
+end

data/lib/canmoia.rb

@@ -0,0 +1,8 @@
+require 'mongoid'
+require 'workflow'
+
+module Canmoia
+  autoload :Order        , 'canmoia/concerns/order'
+  autoload :Work         , 'canmoia/concerns/work'
+  autoload :Notification , 'canmoia/features/notification'
+end

data/lib/canmoia.rb~

@@ -0,0 +1,6 @@
+require 'mongoid'
+require 'workflow'
+
+module Canmoia
+  autoload :Work, 'canmoia/work'
+end

data/lib/tasks/canmoia_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :canmoia do
+#   # Task goes here
+# end

data/lib/tasks/canmoia_tasks.rb.erb

@@ -0,0 +1,16 @@
+require File.expand_path('../../canmoia/tasks/install', __FILE__)
+
+namespace :canmoia do	
+  # Example install task
+  # desc "Install canmoia"
+  # task :install do
+  #   Canmoia::Tasks::Install.start  # Execute all install tasks
+  # end
+
+  # Example update task
+  # desc "Update canmoia"
+  # task :update do
+  #   installation = Canmoia::Tasks::Install.new  # Execute some install tasks
+  #   installation.copy_initializer_file
+  # end
+end