classmeta 0.0.1

data/README.md

@@ -0,0 +1,98 @@
+Classmeta for Rails 3.2+
+=====
+
+Creates new classes on the fly, to allow you to refactor common changes.
+
+Lets say you wanted whitelisted attributes to be different depending which class was including it as an association.
+
+In car, you only want the names of passengers:
+
+    has_many :passengers, class_name: Person.meta(:std, attrs: [:name]).name
+
+In train, you want their seat preference:
+
+    has_many :riders, class_name: Person.meta(:std, attrs: [:name, :seat_preference]).name
+
+etc. You have a ton of these for whatever reason.
+
+So, include the gem in Gemfile and bundle install:
+
+    gem 'classmeta'
+
+Add a transformer somewhere in the load path like app/models/:
+
+    class StandardTransformer
+      def transform(klazz, options)
+        klazz.class_eval "self._accessible_attributes[:default] = #{options[:attrs].inspect}" if options[:attrs]
+      end
+    end
+
+And add this to environment.rb:
+
+    Classmeta::Options.configure({
+      :transformers => {
+        :std => StandardTransformer
+      }
+    })
+
+Now magically car passengers have their accessible attributes set to `:name` and train riders to `[:name, :seat_preference]`!
+
+### How?
+
+Hooking into Rails' load_missing_constant, duping the original class, and doing stuff to it in the transform.
+
+Works with class reloading or caching.
+
+### Why?
+
+Useful if you have a number of classes, like models, in Rails 3.2+ that just differ by a little bit and module includes just aren't solving the problem of doubling, tripling, etc. the number of files you are having to create just to represent new classes.
+
+### Just Rails?
+
+Feel free to do a pull request and add off-Rails support.
+
+### Quick Test!
+
+Add to your Gemfile:
+
+    gem 'classmeta'
+
+Install it:
+
+    bundle install
+
+Open console:
+
+    rails c
+
+Try it:
+
+    YourModel.meta(:echo)
+    YourModel.meta(:echo).name
+    YourModel.meta(:echo, {:say => 'Hello World!'})
+    YourModel.named_meta('Fabular', :echo, {:say => 'Hello World!'})
+    Fabular.all
+
+Note: if you define `Classmeta::Options.configure({...})`, it automatically gets rid of the echo transformer which is just for demonstration purposes. If you want to use it at runtime, you can use:
+
+    Classmeta::Options.configure({
+      :transformers => {
+        :echo => Classmeta::Echo
+      }
+    })
+
+### Troubleshooting
+
+Since Classmeta delegates to Rails's dependency loading, any errors you get like this:
+
+    .../classmeta/lib/classmeta/dependencies.rb:7:in `load_missing_constant': uninitialized constant (something) (NameError)
+
+Just means Rails couldn't find your class.
+
+For other errors, too, for the most part, pretend you are getting that from .../activesupport/lib/activesupport/dependencies.rb, then Google it and scratch your head until you figure out you mistyped something.
+
+### License
+
+Copyright (c) 2012 Gary S. Weaver, released under the [MIT license][lic].
+
+[lic]: http://github.com/garysweaver/classmeta/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+#http://nicksda.apotomo.de/2010/10/testing-your-rails-3-engine-sitting-in-a-gem/
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/classmeta/class.rb

@@ -0,0 +1,34 @@
+require 'securerandom' 
+
+module Classmeta
+  module ClassMethods
+    # e.g. has_many :employees, class_name: MyModel.meta(:ref, attrs: [:name, :status], special_column: 'my_column').name
+    def meta(*args)
+      options = args.extract_options! # separates options hash and leaves one or more transform names
+      self.named_meta("#{self}#{SecureRandom.uuid.gsub('-','')}", args, options)
+    end
+
+    # e.g. has_many :employees, class_name: MyModel.named_meta(MyNewModel, :ref, {attrs: [:name, :status], special_column: 'my_column'}).name
+    # e.g. has_many :employees, class_name: MyModel.named_meta(MyNewModel, [:transform1, :transform2], {attrs: [:name, :status], special_column: 'my_column'}).name
+    def named_meta(new_classname, transform_name_or_names, options = {})
+      transforms = Array.wrap(transform_name_or_names).flatten
+      #puts "#{self.name}.dup will be named: #{name}"
+      new_class = self.dup
+      new_class.instance_eval("def name; #{new_classname.inspect}; end")
+      transforms.each do |transform|
+        transformer = Classmeta::Options.get_transformer(transform)
+        if transformer
+          #puts "#{transformer.name}.transform(#{new_class.name}, #{options.inspect})"
+          transformer.transform(new_class, options)
+        else
+          Classmeta::Options.output
+          raise "Classmeta::Options needs a transformer mapping for #{transform.inspect}"
+        end
+      end
+      #puts "Registering #{name} so class lookup works, if riding Rails"
+      Classmeta::ClassRegistry.register(new_classname, [self, transforms])
+      # TODO: figure out how to cache class in Rails: ActiveSupport::Dependencies::Registry.store(new_class)
+      new_class
+    end
+  end
+end

data/lib/classmeta/class_registry.rb

@@ -0,0 +1,20 @@
+module Classmeta
+  class ClassRegistry
+    @@registry = {}
+
+    def self.register(name, arr)
+      @@registry[name.to_sym] = arr
+    end
+
+    def self.get(name)      
+      arr = @@registry[name.to_sym]
+      if arr
+        # re-meta, so the class that was derived from can be reloaded
+        arr[0].meta(arr[1])
+      else
+        #puts "Didn't find anything for name #{name} in Classmeta's class registry: #{@@registry.inspect}"
+        nil
+      end
+    end
+  end
+end

data/lib/classmeta/dependencies.rb

@@ -0,0 +1,11 @@
+module ActiveSupport
+  module Dependencies
+    alias_method(:load_missing_constant_classmeta_renamed, :load_missing_constant)
+    undef_method(:load_missing_constant)
+    def load_missing_constant(from_mod, const_name)
+      #puts "Classmeta's load_missing_constant from_mod=#{from_mod} const_name=#{const_name}"
+      klazz = Classmeta::ClassRegistry.get(const_name) || load_missing_constant_classmeta_renamed(from_mod, const_name)
+      klazz.class_eval('extend Classmeta::ClassMethods')
+    end
+  end
+end

data/lib/classmeta/echo.rb

@@ -0,0 +1,7 @@
+module Classmeta
+  class Echo
+    def self.transform(klazz, options)
+      puts "Classmeta::Echo.transform(klazz, options) called with klazz: #{klazz.name} and options: #{options.inspect}"
+    end
+  end
+end

data/lib/classmeta/options.rb

@@ -0,0 +1,21 @@
+module Classmeta
+  class Options
+    @@options = {
+      :transformers => {
+        :echo => Classmeta::Echo
+      }
+    }
+
+    def self.configure(hash)
+      @@options = hash
+    end
+
+    def self.get_transformer(name)
+      (@@options[:transformers])[name]
+    end
+
+    def self.output
+      puts "Classmeta::Options=#{@@options.inspect}"
+    end
+  end
+end

data/lib/classmeta/railtie.rb

@@ -0,0 +1 @@
+require 'classmeta'

data/lib/classmeta/version.rb

@@ -0,0 +1,3 @@
+module Classmeta
+  VERSION = '0.0.1'
+end

data/lib/classmeta.rb

@@ -0,0 +1,6 @@
+require 'classmeta/version'
+require 'classmeta/class'
+require 'classmeta/class_registry'
+require 'classmeta/dependencies'
+require 'classmeta/echo'
+require 'classmeta/options'

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: classmeta
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gary S. Weaver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-29 00:00:00.000000000 Z
+dependencies: []
+description: Magic class creator that lets you create and transform classes dynamically.
+email:
+- garysweaver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/classmeta/class.rb
+- lib/classmeta/class_registry.rb
+- lib/classmeta/dependencies.rb
+- lib/classmeta/echo.rb
+- lib/classmeta/options.rb
+- lib/classmeta/railtie.rb
+- lib/classmeta/version.rb
+- lib/classmeta.rb
+- Rakefile
+- README.md
+homepage: https://github.com/garysweaver/activerecord-refs
+licenses:
+- MIT
+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.24
+signing_key: 
+specification_version: 3
+summary: Magic class creation.
+test_files: []