soft_validate 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 DeveloperTown
+
+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,27 @@
+Soft Validate
+=============
+
+Easily recommend fields be filled out in order for something to be considered complete (AKA LinkedIn profile progress)
+
+Install
+-------
+    gem install 'soft_validate'
+
+Usage
+-----
+Add this to your model:
+
+    soft_validates_presence_of :name
+
+And you will get methods like this:
+
+    user.soft_valid?
+    user.soft_errors
+    user.progress_percent
+    user.progress_count
+    user.progress_complete_count
+
+License
+-------
+
+MIT License

data/Rakefile

@@ -0,0 +1,38 @@
+#!/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    = 'SoftValidate'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/soft_validate.rb

@@ -0,0 +1,70 @@
+require 'active_record'
+require 'pry'
+
+module SoftValidate
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    # any method placed here will apply to classes, like Hickwall
+
+    def soft_validates_presence_of(attr)
+      cattr_accessor :soft_attributes
+      self.soft_attributes ||= Array.new
+      self.soft_attributes << attr
+      send :include, InstanceMethods
+    end
+
+    
+
+  end
+
+  module InstanceMethods
+    # any method placed here will apply to instaces, like @hickwall
+    
+    def progress_complete_count
+      self.soft_attributes.length
+    end
+    
+    def soft_valid?
+
+      self.soft_attributes.each do |a|
+        return false if self.attributes[a.to_s].nil?
+      end
+
+      true
+    end
+
+    def soft_errors
+      errors = {}
+      self.soft_attributes.each do |a|
+        if self.attributes[a.to_s].nil?
+          errors[a] = "shouldn't be blank"
+        end
+      end
+
+      errors
+    end
+
+    def progress_count
+      count = 0
+
+      self.soft_attributes.each do |a|
+        if !self.attributes[a.to_s].nil?
+          count += 1
+        end
+      end
+
+      count
+    end
+
+    def progress_percent
+      self.progress_count.to_f / self.progress_complete_count.to_f
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :include, SoftValidate

data/lib/soft_validate/version.rb

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

data/lib/tasks/soft_validate_tasks.rake

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

data/test/database.yml

@@ -0,0 +1,3 @@
+plugin_test:
+  adapter: sqlite3
+  database: ":memory:"

data/test/debug.log

@@ -0,0 +1,25 @@
+# Logfile created on 2012-04-10 18:37:57 -0500 by logger.rb/31641
+   (1.5ms)  select sqlite_version(*)
+   (0.3ms)  CREATE TABLE "dumb_users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar(255), "first_name" varchar(255), "last_name" varchar(255)) 
+   (0.1ms)  CREATE TABLE "non_validated_users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar(255)) 
+   (0.2ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (0.2ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (0.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+   (1.1ms)  select sqlite_version(*)
+   (0.3ms)  CREATE TABLE "dumb_users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar(255), "first_name" varchar(255), "last_name" varchar(255)) 
+   (0.1ms)  CREATE TABLE "non_validated_users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar(255)) 
+   (0.1ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (0.1ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.0ms)  SELECT version FROM "schema_migrations"
+   (0.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+   (1.5ms)  select sqlite_version(*)
+   (0.3ms)  CREATE TABLE "dumb_users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar(255), "first_name" varchar(255), "last_name" varchar(255)) 
+   (0.1ms)  CREATE TABLE "non_validated_users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar(255)) 
+   (0.2ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (0.1ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (0.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')

data/test/dummy/log/test.log

@@ -0,0 +1,6 @@
+   (0.3ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction

data/test/fixtures/dumb_user.rb

@@ -0,0 +1,6 @@
+
+
+class DumbUser < ActiveRecord::Base
+  soft_validates_presence_of :first_name
+  soft_validates_presence_of :last_name
+end

data/test/fixtures/dumb_users.yml

@@ -0,0 +1,10 @@
+invalid:
+  id: 1
+  email: test@example.com
+
+
+valid:
+  id: 2
+  email: test@example.com
+  first_name: dumb
+  last_name: user

data/test/fixtures/non_validated_user.rb

@@ -0,0 +1,2 @@
+class NonValidatedUser < ActiveRecord::Base
+end

data/test/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :dumb_users, :force => true do |t|
+    t.column "email", :string
+    t.column "first_name", :string
+    t.column "last_name", :string
+  end
+
+  create_table :non_validated_users, :force => true do |t|
+    t.column "email", :string
+  end
+end

data/test/soft_validate_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+
+require 'fixtures/non_validated_user'
+
+class SoftValidateTest < TEST_CASE
+  fixtures :dumb_users
+
+  test "truth" do
+    assert_kind_of Module, SoftValidate
+  end
+
+  test "a soft validated record will have the #soft_validates_presence_of method" do
+    assert DumbUser.instance_methods.include?(:soft_valid?)
+  end
+
+  test 'a dumb user will not be soft valid' do
+    assert !DumbUser.new.soft_valid?.nil?
+    assert !DumbUser.new.soft_valid?
+  end
+
+  test 'a fully valid user should return true to #soft_valid?' do
+    user = DumbUser.new(:email => 'me@you.com', :first_name => 'joe', :last_name => 'schmoe')
+    assert user.soft_valid?
+  end
+
+  test 'an invalid user should return error messages' do
+    user = DumbUser.new
+
+    response = user.soft_errors
+    assert !response.nil?
+    assert !response.empty?
+
+    assert response[:first_name].eql?("shouldn't be blank")
+    assert response[:last_name].eql?("shouldn't be blank")
+  end
+
+  test 'a valid user should return an empty error message response' do
+    user = DumbUser.new(:email => 'me@you.com', :first_name => 'joe', :last_name => 'schmoe')
+    assert user.soft_errors.empty?
+  end
+
+  test 'The progress count should reflect the number of soft validated attributes that are populated' do
+    user = DumbUser.new(:email => 'me@you.com', :first_name => 'joe')
+    assert user.progress_count == 1
+
+    user = DumbUser.new(:email => 'me@you.com', :first_name => 'joe', :last_name => 'schmoe')
+    assert user.progress_count == 2
+  end
+
+  test 'The progress complete count should be the number of soft validated attributes' do
+    assert DumbUser.new.progress_complete_count == 2
+  end
+
+  test 'Calling #progress_percent on a partially populated instance should return the right value' do
+    user = DumbUser.new(:email => 'me@you.com', :first_name => 'joe')
+    assert user.progress_percent == 0.50
+  end
+
+  test 'we can instantiate a DumbUser' do
+    ::DumbUser.new({})
+    assert true
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,41 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'soft_validate'
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_record/fixtures'
+# require "#{File.dirname(__FILE__)}/../init"
+
+# require 'fixtures/dumb_user'
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'plugin_test'])
+
+load(File.dirname(__FILE__) + "/schema.rb") if File.exist?(File.dirname(__FILE__) + "/schema.rb")
+
+if ActiveSupport.const_defined?(:TestCase)
+  ActiveSupport::TestCase.send(:include, ActiveRecord::TestFixtures)
+  TEST_CASE = ActiveSupport::TestCase
+else
+  TEST_CASE = Test::Unit::TestCase
+end
+
+TEST_CASE.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$:.unshift(TEST_CASE.fixture_path)
+
+class TEST_CASE #:nodoc:
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(TEST_CASE.fixture_path, table_names) { yield }
+    else
+      Fixtures.create_fixtures(TEST_CASE.fixture_path, table_names)
+    end
+  end
+
+  self.use_transactional_fixtures = false
+  
+  self.use_instantiated_fixtures  = false
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: soft_validate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Christiansen
+- Jason Vasquez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70095288178760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70095288178760
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70095288177280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70095288177280
+description: Add softs_validate_presence_of :attr to your model and it will give you
+  methods to figure out percent complete, missing fields, etc without preventing the
+  record from being saved.
+email:
+- dave@developertown.com
+- jason.vasquez@developertown.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/soft_validate/version.rb
+- lib/soft_validate.rb
+- lib/tasks/soft_validate_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+- test/database.yml
+- test/debug.log
+- test/dummy/db/test.sqlite3
+- test/dummy/log/test.log
+- test/fixtures/dumb_user.rb
+- test/fixtures/dumb_users.yml
+- test/fixtures/non_validated_user.rb
+- test/schema.rb
+- test/soft_validate_test.rb
+- test/test_helper.rb
+homepage: https://github.com/developertown/soft_validate
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Makes it easy to suggest that certain fields be provided, LinkedIn profile
+  style
+test_files:
+- test/database.yml
+- test/debug.log
+- test/dummy/db/test.sqlite3
+- test/dummy/log/test.log
+- test/fixtures/dumb_user.rb
+- test/fixtures/dumb_users.yml
+- test/fixtures/non_validated_user.rb
+- test/schema.rb
+- test/soft_validate_test.rb
+- test/test_helper.rb