completion-progress 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a71b32ba28e0d927e325924c1571a6e9ecf491d4
+  data.tar.gz: 95b4319417eb652eb7fd390bfccdd31a707f1c72
+SHA512:
+  metadata.gz: abefc5727fe45e59c56e9777439e53afa65dd726683c26be3f47e2aaae53800d14a6720846925e3ddb37aa2c8b1246149ab3a76404f7ed9f710013545507aef0
+  data.tar.gz: daa9dd9fbff6a552def3611d2cd85c971eac267eaac142ecd05c2671e1f931ada085ff05affc08d15d3cbdf66087f5337216598a5690ff70c737d20262401ac6

data/.gitignore

@@ -0,0 +1,4 @@
+.idea/
+*.project
+completion-progress-*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rake test
+notifications:
+  email:
+    on_success: never
+    on_failure: change
+gemfile:
+  - Gemfile

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mirko Mignini
+
+MIT License
+
+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,52 @@
+[![Build Status](https://travis-ci.org/MirkoMignini/completion-progress.png?branch=master)](https://travis-ci.org/MirkoMignini/completion-progress)
+
+completion-progress
+===================
+
+DSL to calculate completion level (in percentage or score) of an object based on the value of its properties.
+
+## Requirements
+
+* Ruby 1.9+
+
+## Installation
+
+Add it to your Gemfile:
+
+`gem 'completion-progress'`
+
+Then:
+
+`bundle`
+
+## Usage
+
+Use the completion-progress dsl to define the steps.
+For every step define a name, a value (in percentage or a custom value) and, optionally, a hint to explain the user how to complete the step.
+
+```ruby
+class User
+    include CompletionProgress
+
+    completion_progress :profile do
+      step :name, 30
+      step :surname, 30
+      step :email, 20
+      step :age, 10, {hint: {text: 'Please add your age', href: '/profile/edit'}}
+      step :phones, 10, {hint: {text: 'Please add at least a phone number', href: '/profile/edit/phones'}}
+    end
+    
+    ...
+end
+
+user = User.new
+
+#set the user properties to custom values
+
+user.profile.value #will contains the sum of the values of all the steps which value is not null or empty
+user.profile1.steps[:name].result #check the result (true or false) of a single step
+```
+
+## License
+
+MIT License. Copyright 2014 by Mirko Mignini (https://github.com/MirkoMignini)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/completion-progress.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = 'completion-progress'
+  s.version     = '0.0.2'
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ['MIT']
+  s.summary     = 'Easy progress calculator'
+  s.description = s.summary
+  s.email       = 'mirko.mignini@gmail.com'
+  s.homepage    = 'https://github.com/MirkoMignini/completion-progress'
+  s.authors     = ['Mirko Mignini']
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+end

data/lib/completion-progress.rb

@@ -0,0 +1,4 @@
+require_relative 'completion-progress/initializer'
+
+module CompletionProgress
+end

data/lib/completion-progress/engine.rb

@@ -0,0 +1,51 @@
+require_relative 'step'
+
+class Engine
+  attr_reader :auto_update, :steps, :hints, :value, :percent, :total_value
+  attr_accessor :parent
+
+  def initialize(options = {})
+    @value = 0
+    @total_value = 0
+    @percent = 0
+    @hints = Hash.new
+    @steps = Hash.new
+    @auto_update = options.has_key?(:auto_update) ? options[:auto_update] : true
+  end
+
+  def step(name, value, options = {}, &block)
+    if !@steps.has_key?(name)
+      @steps[name] = Step.new(name, value, options, &block)
+      @total_value += value
+    end
+  end
+
+  def update
+    @value = 0
+    @hints = Hash.new
+    @steps.each do |key, step|
+      step.process(parent) ? @value += step.value : @hints[step.name] = step.hint
+    end
+    @percent = @value * 100 / @total_value
+  end
+
+  def value
+    update if @auto_update
+    @value
+  end
+
+  def steps
+    update if @auto_update
+    @steps
+  end
+
+  def percent
+    update if @auto_update
+    @percent
+  end
+
+  def hints
+    update if @auto_update
+    @hints
+  end
+end

data/lib/completion-progress/hint.rb

@@ -0,0 +1,10 @@
+class Hint
+  attr_accessor :step, :text, :href, :options
+
+  def initialize(step, text, href = '', options = {})
+    @step = step
+    @text = text
+    @href = href
+    @options = options
+  end
+end

data/lib/completion-progress/initializer.rb

@@ -0,0 +1,27 @@
+require_relative 'engine'
+
+module CompletionProgress
+
+  def self.included(base)
+    base.extend CompletionProgress::ClassMethods
+    super
+  end
+
+  module ClassMethods
+
+    @@engines = Hash.new
+
+    def completion_progress(name, options = {}, &block)
+      engine = @@engines[name]
+      if engine == nil
+        engine = Engine.new(options, &block)
+        @@engines[name] = engine
+        define_method(name) do
+          engine.parent = self
+          engine
+        end
+      end
+      engine.instance_eval(&block) if block
+    end
+  end
+end

data/lib/completion-progress/step.rb

@@ -0,0 +1,40 @@
+require_relative 'hint'
+
+class Step
+  attr_accessor :name, :value, :block, :result, :hint
+
+  def initialize(name, value, options = {}, &block)
+    @name = name
+    @value = value
+    @block = block
+    @result = false
+
+    if (options.has_key?(:hint))
+      @hint = Hint.new(self, options[:hint][:text], options[:hint][:href], options[:hint][:options])
+    else
+      @hint = Hint.new(self, "Fill #{name}")
+    end
+  end
+
+  def process(obj)
+    begin
+
+      if !@block
+        val = obj.send(@name)
+      else
+        val = obj.instance_eval(&@block)
+      end
+
+      if val.kind_of?(Array) or val.kind_of?(Hash)
+        @result = val.count == 0 ? false : true
+      else
+        @result = val
+      end
+
+    rescue Exception => e
+      @result = false
+    ensure
+      @result ? @result = true : @result = false
+    end
+  end
+end

data/test/test_all.rb

@@ -0,0 +1,196 @@
+require 'minitest/autorun'
+require_relative '../lib/completion-progress'
+
+class CompletionProgressTest < Minitest::Test
+
+  class User
+    include CompletionProgress
+
+    attr_accessor :name, :surname, :age, :phones, :options, :custom_value
+
+    def initialize
+      @phones = Array.new
+      @options = Hash.new
+    end
+
+    completion_progress :profile1 do
+      step :name, 40, {hint: {text: 'Test hint', href: '/profile/edit', options: {custom: 10}}}
+      step :surname, 40
+      step :age, 20
+    end
+
+    completion_progress :profile2 do
+      step :name, 20
+      step :surname, 20
+      step :age, 10
+    end
+
+    completion_progress :partial_profile do
+      step :name, 40
+    end
+
+    completion_progress :partial_profile do
+      step :surname, 40
+    end
+
+    completion_progress :profile_auto_update_false, auto_update: false do
+      step :name, 40
+    end
+
+    completion_progress :profile_steps do
+      step :name, 5
+      step :phones, 5
+      step :options, 5
+      step :custom, 5 do
+        @custom_value
+      end
+    end
+
+    completion_progress :profile_percent do
+      step :name, 10
+      step :surname, 10
+      step :age, 10
+      step :phones, 10
+      step :custom_value, 10
+    end
+
+  end
+
+  def test_setup
+    user = User.new
+    refute_nil(user)
+  end
+
+  def test_add_method
+    user = User.new
+    refute_nil(user.profile1)
+    refute_nil(user.profile2)
+  end
+
+  def test_steps
+    user = User.new
+    assert_equal(user.profile1.steps.count, 3)
+
+    refute_nil(user.profile1.steps[:name])
+    assert_equal(user.profile1.steps[:name].value, 40)
+
+    refute_nil(user.profile1.steps[:surname])
+    assert_equal(user.profile1.steps[:surname].value, 40)
+
+    refute_nil(user.profile1.steps[:age])
+    assert_equal(user.profile1.steps[:age].value, 20)
+  end
+
+  def test_results
+    user = User.new
+    assert_equal(user.profile1.steps.count, 3)
+
+    assert_equal(user.profile1.steps[:name].result, false)
+    assert_equal(user.profile1.steps[:surname].result, false)
+    assert_equal(user.profile1.steps[:age].result, false)
+
+    user.name = 'Mirko'
+    assert_equal(user.profile1.steps[:name].result, true)
+    assert_equal(user.profile1.steps[:surname].result, false)
+    assert_equal(user.profile1.steps[:age].result, false)
+
+    user.surname = 'Mignini'
+    assert_equal(user.profile1.steps[:name].result, true)
+    assert_equal(user.profile1.steps[:surname].result, true)
+    assert_equal(user.profile1.steps[:age].result, false)
+
+    user.age = 33
+    assert_equal(user.profile1.steps[:name].result, true)
+    assert_equal(user.profile1.steps[:surname].result, true)
+    assert_equal(user.profile1.steps[:age].result, true)
+  end
+
+  def test_values
+    user = User.new
+    assert_equal(user.profile1.value, 0)
+
+    user.name = 'Mirko'
+    assert_equal(user.profile1.value, 40)
+    user.surname = 'Mignini'
+    assert_equal(user.profile1.value, 80)
+    user.age = 33
+    assert_equal(user.profile1.value, 100)
+  end
+
+  def test_multi_object
+    user = User.new
+    user.name = 'Mirko'
+    assert_equal(user.profile1.value, 40)
+    assert_equal(user.profile2.value, 20)
+  end
+
+  def test_auto_update
+    user = User.new
+    assert_equal(user.profile_auto_update_false.value, 0)
+    user.name = 'Mirko'
+    assert_equal(user.profile_auto_update_false.value, 0)
+    user.profile_auto_update_false.update
+    assert_equal(user.profile_auto_update_false.value, 40)
+  end
+
+  def test_variable_types
+    user = User.new
+    assert_equal(user.profile_steps.value, 0)
+
+    user.name = 'Mirko'
+    assert_equal(user.profile_steps.value, 5)
+
+    user.phones << '0911234567'
+    assert_equal(user.profile_steps.value, 10)
+
+    user.options['test'] = 'hello'
+    assert_equal(user.profile_steps.value, 15)
+
+    user.custom_value = true
+    assert_equal(user.profile_steps.value, 20)
+  end
+
+  def test_hints
+    user = User.new
+    refute_nil(user.profile1.hints)
+    assert_equal(user.profile1.hints.count, 3)
+
+    assert_equal(user.profile1.hints[:name].text, 'Test hint')
+    assert_equal(user.profile1.hints[:name].href, '/profile/edit')
+    assert_equal(user.profile1.hints[:name].options[:custom], 10)
+
+    assert_equal(user.profile1.hints[:surname].text, 'Fill surname')
+    assert_equal(user.profile1.hints[:surname].href, '')
+    assert_equal(user.profile1.hints[:surname].options.count, 0)
+
+    user.name = 'Mirko'
+    assert_equal(user.profile1.hints.count, 2)
+
+    user.surname = 'Mignini'
+    assert_equal(user.profile1.hints.count, 1)
+
+    user.age = 33
+    assert_equal(user.profile1.hints.count, 0)
+  end
+
+  def test_percent
+    user = User.new
+    assert_equal(user.profile_percent.percent, 0)
+    user.name = 'Mirko'
+    assert_equal(user.profile_percent.percent, 20)
+    user.surname = 'Mignini'
+    assert_equal(user.profile_percent.percent, 40)
+    user.age = 33
+    assert_equal(user.profile_percent.percent, 60)
+    user.phones = '0911234567'
+    assert_equal(user.profile_percent.percent, 80)
+    user.custom_value = 'test'
+    assert_equal(user.profile_percent.percent, 100)
+  end
+
+  def test_partials
+    user = User.new
+    assert_equal(user.partial_profile.steps.count, 2)
+  end
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: completion-progress
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Mirko Mignini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-24 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  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: Easy progress calculator
+email: mirko.mignini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- completion-progress.gemspec
+- lib/completion-progress.rb
+- lib/completion-progress/engine.rb
+- lib/completion-progress/hint.rb
+- lib/completion-progress/initializer.rb
+- lib/completion-progress/step.rb
+- test/test_all.rb
+homepage: https://github.com/MirkoMignini/completion-progress
+licenses:
+- MIT
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Easy progress calculator
+test_files:
+- test/test_all.rb