progression 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Michael Guterl
+
+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.md

@@ -0,0 +1,83 @@
+# progression
+
+progression provides a set of simple utility classes and a DSL for
+measuring an objects progress through a progression of steps.  This is
+especially useful for defining and calculating profile completion
+status in a social application.
+
+There are a few existing solutions similar to progression, but they
+try to do too much.  The other options that I am familiar with are
+either coupled with ActiveRecord or ActionController in some way.
+
+## DSL syntax
+
+    class User < Struct.new(:first_name, :last_name, :email, :phone)
+
+      include Progression
+
+      progression :registration do
+        step :step_1 do
+          first_name.present? && last_name.present?
+        end
+
+        step :step_2 do
+          email.present? && phone.present?
+        end
+      end
+    end
+
+    user = User.new
+    user.registration_progress.completed_steps # => []
+    user.registration_progress.percentage_complete # => 0.0
+    user.next_step.name # => :step_1
+
+    user.first_name = "Michael"
+    user.last_name  = "Jordan"
+    user.registration_progress.completed_steps # => [:step_1]
+    user.registration_progress.percentage_complete # => 50.0
+    user.next_step.name # => :step_2
+
+    ...
+
+
+## Utility classes
+
+    registration = Progression::Progression.new
+    registration.steps << Progression::Step.new(:step_1) { !first_name.blank? && !last_name.blank? }
+    registration.steps << Progression::Step.new(:step_2) { !email.blank? && !phone.blank? }
+
+    User = Struct.new(:first_name, :last_name, :email, :phone)
+    user = User.new
+
+    progress = registration.progress_for(user)
+    progress.completed_steps # => []
+    progress.percentage_completed # => 0.0
+    progress.next_step.name # => :step_1
+
+    user.first_name = "Michael"
+    user.last_name  = "Jordan"
+
+    progress.completed_steps # => [:step_1]
+    progress.percentage_completed # => 50.0
+    progress.next_step.name # => :step_2
+
+    user.email = "michael@jordan.com"
+    user.phone = "513-347-1111"
+
+    progress.completed_steps # => [:step_1, :step_2]
+    progress.percentage_completed # => 100.0
+    progress.next_step # => nil
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Michael Guterl. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "progression"
+    gem.summary = %Q{progression provides a set of simple utility classes and a DSL for measuring an objects progress through a progression of steps}
+    gem.description = %Q{progression provides a set of simple utility classes and a DSL for
+measuring an objects progress through a progression of steps.  This is
+especially useful for defining and calculating profile completion
+status in a social application.
+
+There are a few existing solutions similar to progression, but they
+try to do too much.  The other options that I am familiar with are
+either coupled with ActiveRecord or ActionController in some way.
+}
+    gem.email = "mguterl@gmail.com"
+    gem.homepage = "http://github.com/mguterl/progression"
+    gem.authors = ["Michael Guterl"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "progression #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/progression.rb

@@ -0,0 +1,82 @@
+module Progression
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    def progression(name, &block)
+      (class << self; self; end).send(:define_method, "#{name}_progression") do
+        Progression.new(&block)
+      end
+
+      define_method("#{name}_progress") do
+        self.class.send("#{name}_progression").progress_for(self)
+      end
+    end
+
+  end
+
+  class Progression
+
+    attr_reader :steps
+
+    def initialize(&block)
+      @steps = []
+      instance_exec &block if block_given?
+    end
+
+    def progress_for(object)
+      Progress.new(object, steps)
+    end
+
+    private
+
+    def step(name, &block)
+      @steps << Step.new(name, &block)
+    end
+
+  end
+
+  class Progress
+
+    attr_reader :steps
+
+    def initialize(object, steps)
+      @object = object
+      @steps = steps
+    end
+
+    def completed_steps
+      steps.select do |step|
+        step.evaluate(@object)
+      end
+    end
+
+    def percentage_completed
+      (completed_steps.size / steps.size.to_f) * 100
+    end
+
+    def next_step
+      steps.find do |step|
+        !step.evaluate(@object)
+      end
+    end
+  end
+
+  class Step
+
+    attr_reader :name
+
+    def initialize(name, &block)
+      @name, @block = name, block
+    end
+
+    def evaluate(object)
+      object.instance_exec &@block
+    end
+
+  end
+
+end

data/spec/progression_spec.rb

@@ -0,0 +1,97 @@
+require 'spec/spec_helper'
+
+class Profile < Struct.new(:first_name, :last_name)
+
+  include Progression
+
+  progression :profile do
+
+    step :step_1 do
+      !first_name.blank?
+    end
+
+    step :step_2 do
+      !last_name.blank?
+    end
+
+  end
+
+  # def self.profile_progression
+  #   @progression ||= Progression::Progression.new do
+  #     steps << Progression::Step.new(:step_1) { !first_name.blank? }
+  #     steps << Progression::Step.new(:step_2) { !last_name.blank? }
+  #   end
+  # end
+
+  # def profile_progress
+  #   self.class.profile_progression.progress_for(self)
+  # end
+
+end
+
+describe "Progression" do
+
+  before do
+    @profile = Profile.new
+    @progression = @profile.profile_progress
+  end
+
+  it 'should return a list of steps' do
+    @progression.should have(2).steps
+  end
+
+  it 'should return a list of completed steps' do
+    @progression.should have(0).completed_steps
+  end
+
+  it 'should return the percentage completed' do
+    @progression.percentage_completed.should == 0.0
+  end
+
+  it 'should return the next step to be completed' do
+    @progression.next_step.name.should == :step_1
+  end
+
+  describe "after first step" do
+
+    before do
+      @profile.first_name = "Michael"
+      @progression = @profile.profile_progress
+    end
+
+    it 'should have 1 completed step' do
+      @progression.should have(1).completed_steps
+    end
+
+    it 'should return the percentage completed' do
+      @progression.percentage_completed.should == 50.0
+    end
+
+    it 'should return the next step to be completed' do
+      @progression.next_step.name.should == :step_2
+    end
+
+    describe "and second step" do
+
+      before do
+        @profile.last_name = "Jordan"
+        @progression = @profile.profile_progress
+      end
+
+      it 'should have 1 completed step' do
+        @progression.should have(2).completed_steps
+      end
+
+      it 'should return the percentage completed' do
+        @progression.percentage_completed.should == 100.0
+      end
+
+      it 'should return nil when there are no more steps to be completed' do
+        @progression.next_step.should == nil
+      end
+
+    end
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'progression'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: progression
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Guterl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: |
+  progression provides a set of simple utility classes and a DSL for
+  measuring an objects progress through a progression of steps.  This is
+  especially useful for defining and calculating profile completion
+  status in a social application.
+  
+  There are a few existing solutions similar to progression, but they
+  try to do too much.  The other options that I am familiar with are
+  either coupled with ActiveRecord or ActionController in some way.
+
+email: mguterl@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/progression.rb
+- spec/progression_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mguterl/progression
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: progression provides a set of simple utility classes and a DSL for measuring an objects progress through a progression of steps
+test_files: 
+- spec/progression_spec.rb
+- spec/spec_helper.rb