godel 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07d0985ff32342c58cb61fe968a193fc5ab067f4
+  data.tar.gz: 4719d79dd938c653e29f7dc88023c9135bc89c84
+SHA512:
+  metadata.gz: 1f3a7521b20036ace6f568ed182da21aea39e94d80bd8cc487b59630105002dcef1f6d95eb92852f07d0780c0139c85a6386518c921537e3ae018c91aa5668a0
+  data.tar.gz: 5031bea9ed1f3cd2661639bc5962db26f97e3fbc104a4bd41ff8553e0a60811ca33d7e564ef56d19680f3a5c0bc584463b3682f066f48aa5a50c7dada80ac03b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+ruby "2.0.0" 
+
+gem 'activerecord'
+gem 'sqlite3'
+gem 'byebug'
+gem 'rake'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Jarvis
+
+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,98 @@
+# Godel
+##Validations, Except they don't do anything.
+
+In Rails apps, it is possible that a model might want another state above 'valid' or 'invalid'. Unreliable inputs may put you in a situation where you can not guarantee the integrity of every entry in your database, but strict validations might cause you to lose fuzzy data.
+
+This gem gives another 'state' about validity, "completeness". A model can require certain attributes or methods to be present in order to be 'complete', giving you another powerful tool when solidfying the integrity of your data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'godel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install godel
+
+## Usage
+
+include Godel in any model you'd like to measure completeness in.
+
+    include Godel
+
+You can define attributes required for completeness with the 'completes' command. you can also use
+"incomplete_without".
+
+    completes :foo, :bar, :baz
+
+You can also define methods required for completeness. In these methods, create a warning (analagous to 'errors' in validations) should it be incomplete.
+
+    completes_method :must_have_name_or_email
+
+    ...
+
+    private
+
+    def must_have_name_or_email
+      if name.blank? && email.blank?
+        warnings.add(:name_or_email, "Needs either Name or Email")
+      end
+
+    end
+
+
+You can query the completeness of a method with the #complete? or #incomplete? method, and you can see the relevant warnings with the #warnings method. 
+
+
+    class ReadmeClass
+      completes :foo
+      completes_method :must_have_bar_over_five
+
+      private
+
+      def must_have_bar_over_five
+        if bar < 5
+          warnings.add(:bar_over_five, "Bar must be > 5")
+        end
+      end
+    end
+
+    readme = ReadmeClass.create
+    readme.incomplete?
+      # => true
+    readme.warnings
+      # => #<Godel::Warnings::0x007efc7f7b11a0 @messages={:foo => "ReademeClass is incomplete without foo", :bar_over_five => "Bar must be > 5"}
+
+    readme.update_attributes(foo: "Foo")
+
+    readme.incomplete?
+      # => true
+    readme.warnings
+      # => #<Godel::Warnings::0x007efc7f7b11a0 @messages={:bar_over_five => "Bar must be > 5"}
+
+    readme.update_attributes(bar: 6)
+j
+    readme.incomplete?
+      # => false
+    readme.warnings
+      # => #<Godel::Warnings::0x007efc7f7b11a0 @messages={}
+
+    readme.complete?
+      #=> true
+
+## Development Goals
+  - api matching rails validation syntax
+  - decouple from rails (allow completeness on PORO's)
+
+## Contributing 
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/godel'
+  t.pattern = "test/*/*_test.rb"
+  t.verbose = true
+end
+
+task default: [:test]

data/godel.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'godel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "godel"
+  spec.version       = Godel::VERSION
+  spec.authors       = ["Alex Jarvis"]
+  spec.email         = ["alxjrvs@gmail.com"]
+  spec.description   = %q{Validations, except they don't do anything.}
+  spec.summary       = %q{In Rails apps, it is possible that a model might want another state above 'valid' or 'invalid'. Unreliable inputs may put you in a situation where you can not guarantee the  integrity of every entry in your database, but strict validations might cause you to lose fuzzy data. This gem gives another 'state' about validity, "completeness". A model can require certain attributes or methods to be present in order to be 'complete', giving you another powerful tool when solidfying the integrity of your data. }
+  spec.homepage      = "https://github.com/alxjrvs/godel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "byebug"
+end

data/lib/godel.rb

@@ -0,0 +1,54 @@
+require "godel/version"
+require 'godel/warnings'
+require 'godel/class_methods'
+
+module Godel
+  def self.included(klass)
+    klass.extend ClassMethods
+    klass.cattr_accessor :_incomplete_methods, :_incomplete_attrs
+    klass.after_save :clear_godel_cache
+    klass.after_create :clear_godel_cache
+    klass._incomplete_methods ||= []
+    klass._incomplete_attrs ||= []
+  end
+
+  def complete?
+    !incomplete?
+  end
+
+  def incomplete?
+    @_incomplete ||= begin
+      return false if _incomplete_attrs.empty? && _incomplete_methods.empty?
+        warnings.any?
+    end
+  end
+
+  attr_accessor :warnings
+
+  def warnings
+    @_warnings ||= Warnings.new
+  end
+
+  private
+
+
+  def clear_godel_cache
+    @_incomplete = nil
+    warnings.clear!
+    _filter_incomplete_attributes
+    _filter_incomplete_methods
+  end
+
+  def _filter_incomplete_attributes
+    _incomplete_attrs.each do |attr|
+      value = self.send(attr)
+      warnings.add(attr, "#{self.class} is incomplete without #{attr}") unless value.present?
+    end
+  end
+
+  def _filter_incomplete_methods
+    _incomplete_methods.each do |method|
+      self.send(method)
+    end
+  end
+end

data/lib/godel/class_methods.rb

@@ -0,0 +1,15 @@
+module ClassMethods
+  def completes(*args)
+    args.map(&:to_sym).each {|arg| _incomplete_attrs << arg}
+  end
+  alias_method :incomplete_without, :completes
+
+  def completes_method(method)
+    _incomplete_methods << method.to_sym
+  end
+  alias_method :incomplete_unless, :completes_method
+
+
+  private
+
+end

data/lib/godel/version.rb

@@ -0,0 +1,3 @@
+module Godel
+  VERSION = "0.0.2"
+end

data/lib/godel/warnings.rb

@@ -0,0 +1,43 @@
+module Godel
+  class Warnings
+    attr_accessor :messages
+
+    def initialize
+      @messages = {}
+    end
+
+    def values
+      messages.values
+    end
+
+    def add(symbol, message = nil)
+      message ||= "is missing"
+      messages[symbol] = message
+    end
+
+    def any?
+      messages.any?
+    end
+
+    def empty?
+      messages.empty?
+    end
+
+    def blank?
+      messages.blank?
+    end
+
+    def to_a
+      full_messages
+    end
+
+    def full_messages
+      array = []
+      messages.each {|k,v| array << "#{k.to_s.titleize} #{v}"}
+    end
+
+    def clear!
+      self.messages = {}
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+
+using_git = File.exist?(File.expand_path('../../.git/', __FILE__))
+require 'bundler/setup' if using_git
+
+require File.expand_path('../../lib/godel.rb', __FILE__)
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'active_record'
+require 'byebug'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :test_classes, force: true do |t|
+    t.string :foo
+    t.string :baz
+    t.integer :pug
+    t.integer :stuff
+  end
+
+end
+class TestClass < ActiveRecord::Base
+  include Godel
+
+  completes :foo, :baz
+  completes_method :either_pug_or_stuff
+
+  private
+
+  def either_pug_or_stuff
+    if pug.blank? && stuff.blank?
+      warnings.add(:pug_or_stuff, "Needs either Pug or Stuff to be complete")
+    end
+  end
+end
+
+
+
+

data/test/unit/incompleteness_test.rb

@@ -0,0 +1,29 @@
+require_relative '../test_helper'
+
+class IncompletenessTest < MiniTest::Unit::TestCase
+
+  def test_that_included_models_respond_to_methods
+    assert @test_class.respond_to? :incomplete?
+    assert @test_class.respond_to? :complete?
+  end
+
+  def test_that_incomplete_models_report_correctly
+    assert @test_class.incomplete?, "Freshly created model with no attributes should be incomplete"
+    refute @test_class.complete?, "Freshly created models with no attributes should not be complete"
+  end
+
+  def test_that_incomplete_models_may_be_made_complete
+    assert @test_class.incomplete?, "Model is new and has no attributes, should be incomplete."
+    @test_class.update_attributes(foo: "foo", baz: "baz", pug: 52, stuff: 666)
+    assert @test_class.complete?, "Model has satisfied the given avenues of completeness, and should be complete"
+  end
+
+  def setup
+    @test_class = TestClass.create
+  end
+
+  def teardown
+    TestClass.destroy_all
+  end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: godel
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alex Jarvis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: byebug
+  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: Validations, except they don't do anything.
+email:
+- alxjrvs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- godel.gemspec
+- lib/godel.rb
+- lib/godel/class_methods.rb
+- lib/godel/version.rb
+- lib/godel/warnings.rb
+- test/test_helper.rb
+- test/unit/incompleteness_test.rb
+homepage: https://github.com/alxjrvs/godel
+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.0.0
+signing_key: 
+specification_version: 4
+summary: In Rails apps, it is possible that a model might want another state above
+  'valid' or 'invalid'. Unreliable inputs may put you in a situation where you can
+  not guarantee the  integrity of every entry in your database, but strict validations
+  might cause you to lose fuzzy data. This gem gives another 'state' about validity,
+  "completeness". A model can require certain attributes or methods to be present
+  in order to be 'complete', giving you another powerful tool when solidfying the
+  integrity of your data.
+test_files:
+- test/test_helper.rb
+- test/unit/incompleteness_test.rb