groupy 0.2.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [Matthew Rudy Jacobs]
+
+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

@@ -0,0 +1,92 @@
+Groupy
+=======
+
+Categorise records into nested groups of values.
+
+Example
+=======
+
+Define our groups
+
+  class Food
+    property :dish, String
+
+    include Groupy
+    groupy :dish do
+      group :healthy do
+        group :fruit do
+          value :apple
+          value :orange
+        end
+        value :rice
+      end
+
+      group :unhealthy do
+        value :fried_egg
+        value :bacon
+      end
+    end
+  end
+
+We can then ask a particular food:
+
+  apple.healthy?
+  apple.fruit?
+  apple.apple?
+
+And we can scope the class by any of these groups
+
+  Food.apples.count
+  Food.fruits.all
+  
+We also get a magic "all_" method
+
+  Food.all_dishes
+
+You can also tell groupy to add the column name as a suffix
+
+  class Something
+    groupy :size, :suffix => true do
+      value :small
+      value :medium
+      value :large
+    end
+  end
+
+  something.small_size?
+  
+Or you may want to store all the values as a conveniently named constant.
+
+  class Something
+    groupy :size, :constants => true do
+      value :small
+      value :medium
+      value :large
+    end
+  end
+
+  Something::SMALL
+  Something::MEDIUM
+  Something::LARGE
+  
+Or of course you can do both together
+
+  Something::SMALL_SIZE
+  Something::MEDIUM_SIZE
+  Something::LARGE_SIZE
+
+Any values will be lowercased and underscored
+
+  class Something
+    groupy :type do
+      value :SomeClass
+      value :"Namespace::KlassName"
+    end
+  end
+
+  something.some_class?
+  something.namespace_klass_name?  
+  
+B00m!
+
+Copyright (c) 2010 [Matthew Rudy Jacobs], released under the MIT license

data/Rakefile

@@ -0,0 +1,85 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test Groupy.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for Groupy.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Groupy'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require "rake/gempackagetask"
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "groupy"
+  s.version           = "0.2.1"
+  s.summary           = "Categorise Active Records in nested groups with magical scopes, ? methods, and constants."
+  s.author            = "Matthew Rudy Jacobs"
+  s.email             = "MatthewRudyJacobs@gmail.com"
+  s.homepage          = "https://github.com/matthewrudy/groupy"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README)
+  s.rdoc_options      = %w(--main README)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(README MIT-LICENSE Rakefile) + Dir.glob("{test,lib}/**/*")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  s.add_dependency("activesupport")
+
+  # If your tests use any gems, include them here
+  # s.add_development_dependency("mocha") # for example
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more 
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# If you don't want to generate the .gemspec file, just remove this line. Reasons
+# why you might want to generate a gemspec:
+#  - using bundler with a git source
+#  - building the gem without rake (i.e. gem build blah.gemspec)
+#  - maybe others?
+task :package => :gemspec
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/lib/groupy.rb

@@ -0,0 +1,134 @@
+require 'active_support/core_ext/class/attribute_accessors'
+
+module Groupy
+
+  def self.included(klass)
+    klass.class_eval do
+      extend ClassMethods
+      
+      cattr_accessor :groupies
+      self.groupies = {}
+    end
+  end
+
+  module ClassMethods
+
+    def groupy(column, options={}, &block)
+      container = OuterGroup.new(&block)
+      container.attach!(self, column, options)
+      self.groupies[column] = container
+    end
+
+  end
+
+  class Group
+
+    def initialize(name, &block)
+      @name = name
+      @sub_groups = []
+
+      instance_eval(&block)
+    end
+    attr_reader :name, :sub_groups
+ 
+    def values
+      value_groups.map{|g| g.value}
+    end
+    
+    def value_groups
+      self.sub_groups.inject([]) do |array, sg|
+        if sg.is_a?(Value)
+          array << sg
+        else
+          array += sg.value_groups
+        end
+      end
+    end
+
+    def subgroups
+      self.sub_groups.inject({}) do |hash, g|
+        if g.respond_to?(:subgroups)
+          hash.merge!(g.subgroups)
+        end
+        hash[g.name] = g.values
+        hash
+      end
+    end
+
+    private
+
+    def group(name, &block)
+      subgroup = Group.new(name, &block)
+      self.sub_groups << subgroup
+    end
+
+    def value(name)
+      self.sub_groups << Value.new(name)
+    end
+
+  end
+
+  class OuterGroup < Group
+    
+    def initialize(&block)
+      super(:all, &block)
+    end
+
+    def attach!(klass, column_name, options)
+      self.subgroups.each do |group_name, group_values|
+
+        method_name = if options[:suffix]
+          "#{group_name}_#{column_name}"
+        else
+          group_name
+        end
+
+        klass.class_eval <<-RUBY
+          def #{method_name}?
+            #{group_values.inspect}.include?(self.#{column_name})
+          end
+        RUBY
+        
+        scope_name = method_name.to_s.pluralize
+        
+        if defined?(ActiveRecord) && klass < ActiveRecord::Base
+          klass.scope(scope_name, klass.where(column_name => group_values))
+        end
+      end
+      
+      if options[:constants]
+        self.value_groups.each do |value_group|
+          
+          constant_name = if options[:suffix]
+            "#{value_group.name}_#{column_name}"
+          else
+            value_group.name
+          end
+          klass.const_set("#{constant_name.upcase}", value_group.value)
+        end
+      end
+      
+      klass.class_eval <<-RUBY
+        def self.all_#{column_name.to_s.pluralize}
+          self.groupies[#{column_name.inspect}].values
+        end
+      RUBY
+    end
+  
+  end
+
+  class Value
+
+    def initialize(name)
+      @name  = name.to_s.gsub("::", "").underscore.to_sym
+      @value = name.to_s.freeze
+    end
+    attr_reader :name, :value
+    
+    def values
+      [value]
+    end
+
+  end
+
+end

data/test/groupy_test.rb

@@ -0,0 +1,103 @@
+require 'test_helper'
+
+require 'groupy'
+
+class GroupyTest < ActiveSupport::TestCase
+  
+  class Food
+
+    def initialize(dish)
+      @dish = dish
+      @spiciness = "small"
+    end
+    attr_reader :dish
+    attr_reader :spiciness
+
+    include Groupy
+    groupy :dish do
+      group :healthy do
+        group :fruit do
+          value :apple
+          value :orange
+        end
+        value :rice
+      end
+
+      group :unhealthy do
+        value :fried_egg
+        value :bacon
+      end
+    end
+
+    # we can have multiple groupies
+    groupy :spiciness, :suffix => true, :constants => true do
+      group :wussy do
+        value :small
+      end
+      value :extreme
+    end
+    
+  end
+  
+  test "groupies" do
+    groupy = Food.groupies[:dish]
+    assert_instance_of Groupy::OuterGroup, groupy
+  end
+
+  test "subgroups" do
+    assert_equal [:healthy, :fruit, :apple, :orange, :rice, :unhealthy, :fried_egg, :bacon].sort_by(&:to_s), Food.groupies[:dish].subgroups.keys.sort_by(&:to_s)
+    assert_equal ["apple", "orange", "rice"], Food.groupies[:dish].subgroups[:healthy]
+    assert_equal ["apple", "orange"],         Food.groupies[:dish].subgroups[:fruit]
+    assert_equal ["apple"],                   Food.groupies[:dish].subgroups[:apple]
+  end
+  
+  test "all_" do
+    assert_equal ["apple", "orange", "rice", "fried_egg", "bacon"].sort, Food.all_dishes.sort
+  end
+
+  test "? methods" do
+    orange = Food.new("orange")
+    assert orange.healthy?
+    assert !orange.rice?
+    assert orange.fruit?
+    assert orange.orange?
+  
+    # and the second groupy
+    assert orange.wussy_spiciness?
+    assert orange.small_spiciness?
+    assert !orange.extreme_spiciness?
+  end
+  
+  test "constants" do
+    assert_equal "small",   Food::SMALL_SPICINESS
+    assert_equal "extreme", Food::EXTREME_SPICINESS
+  end
+  
+  class Thing
+    include Groupy
+
+    def initialize(type)
+      @type = type
+    end
+    attr_reader :type
+    
+    groupy :type do
+      group :number do
+        value :FixNum
+        value "My::FixNum"
+      end
+      value :String
+    end
+  end
+
+  test "underscore value methods" do
+    number = Thing.new("My::FixNum")
+    assert number.number?
+    assert !number.fix_num?
+    assert number.my_fix_num?
+    assert !number.string?
+  end
+  
+  # TODO: setup an AR test
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+
+$:.unshift File.expand_path(File.dirname(__FILE__)+"/../lib")

data/test/with_database_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+require 'groupy'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :dbfile  => ":memory:",
+    :database => "groupy_test"
+)
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :somethings, :force => true do |t|
+    t.string :size
+  end
+end
+
+class Something < ActiveRecord::Base
+  
+  include Groupy
+  
+  groupy :size, :suffix => true do
+    value :small
+    value :medium
+    value :large
+  end
+end
+
+class WithDatabaseTest < ActiveSupport::TestCase
+  
+  test "scopes" do
+    assert_equal [], Something.small_sizes.all
+    assert_equal 0,  Something.small_sizes.count
+    assert_equal [], Something.medium_sizes.all
+    assert_equal 0,  Something.medium_sizes.count
+    
+    small1 = Something.create!(:size => "small")
+    medium = Something.create!(:size => "medium")
+    small2 = Something.create!(:size => "small")
+    
+    assert_equal [small1, small2], Something.small_sizes.all
+    assert_equal 2,                Something.small_sizes.count
+    assert_equal [medium],         Something.medium_sizes.all
+    assert_equal 1,                Something.medium_sizes.count
+  end
+  
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: groupy
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Matthew Rudy Jacobs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-14 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: MatthewRudyJacobs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- MIT-LICENSE
+- Rakefile
+- test/groupy_test.rb
+- test/test_helper.rb
+- test/with_database_test.rb
+- lib/groupy.rb
+has_rdoc: true
+homepage: https://github.com/matthewrudy/groupy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Categorise Active Records in nested groups with magical scopes, ? methods, and constants.
+test_files: []
+