new_class 0.1.0

data/.gitignore

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

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+= NewClass CHANGELOG
+
+== Version 0.1.0 (November 23, 2011)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :gem_default do
+  gem "new_class", :path => "."
+end
+
+group :gem_development do
+  gem "pry"
+end
+
+group :gem_test do
+  gem "shoulda"
+  gem "mocha"
+  gem "activerecord", :require => "active_record"
+  gem "sqlite3"
+  gem "rmagick"
+  gem "carrierwave"
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Paul Engel
+
+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.textile

@@ -0,0 +1,152 @@
+h1. NewClass
+
+Define variable dependent classes without using class_eval
+
+h2. Introduction
+
+I think we as Ruby programmers are blessed with the power of meta programming as we can program classes and instances dynamically within the Ruby language. These are just a couple of methods we can use as tools:
+
+* eval / module_eval / class_eval / instance_eval
+* class_variables / instance_variables
+* class_variable_get / class_variable_set
+* instance_variable_get / instance_variable_set
+* define_method / undef_method / remove_method
+* send
+* method_missing
+* Class.new
+
+Some of the methods (such as @eval@, @class_eval@ and @instance_eval@) are often seen as evil and also, they can be very dangerous.
+
+h3. Dynamic CarrierWave uploader classes
+
+In my case, I had to define "CarrierWave":https://github.com/jnicklas/carrierwave uploader classes dynamically as they are dependent of certain variables. Choosing not to use @class_eval@ for this task, I have created the @NewClass@ gem to accomplish this.
+
+Instead of defining a CarrierWave uploader class with something like this:
+
+<pre>
+  config = {
+    :processor => CarrierWave::RMagick,
+    :storage => :file,
+    :versions => [[800, 800], {:thumb => [200, 200]}, {:icon => [100, 100]}],
+    :extension_white_list => %w(jpg jpeg gif png)
+  }
+
+  avatar_uploader = Class.new(CarrierWave::Uploader::Base).tap do |klass|
+    klass.instance_eval <<-RUBY
+      include #{config[:processor].to_s}
+      storage :#{config[:storage]}
+
+      def store_dir
+        "uploads/\#{model.class.to_s.underscore}/\#{mounted_as}/\#{model.id}"
+      end
+
+      def cache_dir
+        "tmp"
+      end
+
+      def extension_white_list
+        %w(#{config[:extension_white_list].join " "})
+      end
+    RUBY
+
+    config[:versions].each do |v|
+      case v.class.name
+      when "Array"
+        klass.process :resize_to_fit => v
+      when "Hash"
+        klass.instance_eval <<-RUBY
+          version :#{v.keys.first} do
+            process :resize_to_fit => [#{v.values.first[0]}, #{v.values.first[1]}]
+          end
+        RUBY
+      end
+    end
+  end
+</pre>
+
+I am able to define the class like this:
+
+<pre>
+  config = {
+    :processor => CarrierWave::RMagick,
+    :storage => :file,
+    :versions => [[800, 800], {:thumb => [200, 200]}, {:icon => [100, 100]}],
+    :extension_white_list => %w(jpg jpeg gif png)
+  }
+
+  class Uploader < CarrierWave::Uploader::Base
+    include NewClass
+
+    def self.defined
+      include config[:processor]
+      storage config[:storage]
+
+      config[:versions].each do |v|
+        case v.class.name
+        when "Array"
+          process :resize_to_fit => v
+        when "Hash"
+          version v.keys.first do
+            process :resize_to_fit => v.values.first
+          end
+        end
+      end
+    end
+
+    def store_dir
+      "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+    end
+
+    def cache_dir
+      "tmp"
+    end
+
+    def extension_white_list
+      config[:extension_white_list]
+    end
+  end
+
+  avatar_uploader = Uploader.new_class(:config => config)
+</pre>
+
+A much cleaner solution right? Try out @NewClass@ right now and spread the word if you like it! ^^
+
+h2. Installation
+
+h3. Using Bundler
+
+Add NewClass in @Gemfile@ as a gem dependency:
+
+<pre>
+  gem "new_class"
+</pre>
+
+Run the following in your console to install with Bundler:
+
+<pre>
+  bundle install
+</pre>
+
+h2. Last remarks
+
+Please check out "test/carrierwave_test.rb":https://github.com/archan937/new_class/blob/master/test/carrierwave_test.rb and "test/class_test.rb":https://github.com/archan937/new_class/blob/master/test/class_test.rb for most of the tests available. You can run the unit tests with @rake@ within the terminal.
+
+Also, the NewClass repo is provided with @script/console@ which you can run for testing purposes.
+
+Note: *NewClass is successfully tested using Ruby 1.8.7 and Ruby 1.9.2*
+
+h2. Contact me
+
+For support, remarks and requests please mail me at "paul.engel@holder.nl":mailto:paul.engel@holder.nl.
+
+h2. License
+
+Copyright (c) 2011 Paul Engel, released under the MIT license
+
+"http://holder.nl":http://holder.nl – "http://codehero.es":http://codehero.es – "http://gettopup.com":http://gettopup.com – "http://github.com/archan937":http://github.com/archan937 – "http://twitter.com/archan937":http://twitter.com/archan937 – "paul.engel@holder.nl":mailto:paul.engel@holder.nl
+
+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/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |test|
+  test.pattern = "test/**/*_test.rb"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/new_class.rb

@@ -0,0 +1,50 @@
+require "active_support/core_ext/class/attribute"
+require "active_support/concern"
+require "new_class/version" unless defined?(NewClass::VERSION)
+
+module NewClass
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def new_class(variables = {}, name = nil)
+      Class.new(self).tap do |klass|
+        klass.send :include, Concerns, MethodMissing
+        klass.extend MethodMissing
+        klass._name = name || self.name
+        klass._variables = variables.inject({}){|h, (k, v)| h.merge k.to_sym => v}
+        klass.defined if klass.respond_to?(:defined)
+      end
+    end
+
+    module Concerns
+      extend ActiveSupport::Concern
+      included do
+        class_attribute :_name, :_variables
+      end
+      module ClassMethods
+        def name
+          _name || super
+        end
+        alias :to_s :name
+      end
+      module InstanceMethods
+        def _variables
+          self.class._variables
+        end
+      end
+    end
+
+    module MethodMissing
+      def method_missing(method, *args)
+        _variables.include?(key = method.to_sym) ? define_method(key){ _variables[key] }.call : super
+      end
+      def respond_to?(symbol, include_private = false)
+        _variables.include?(symbol.to_sym) || super
+      end
+    end
+  end
+
+end

data/lib/new_class/version.rb

@@ -0,0 +1,7 @@
+module NewClass
+  MAJOR = 0
+  MINOR = 1
+  TINY  = 0
+
+  VERSION = [MAJOR, MINOR, TINY].join(".")
+end

data/new_class.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/new_class/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paul Engel"]
+  gem.email         = ["paul.engel@holder.nl"]
+  gem.description   = %q{Define variable dependent classes without using class_eval}
+  gem.summary       = %q{Define variable dependent classes without using class_eval}
+  gem.homepage      = "https://github.com/archan937/new_class"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "new_class"
+  gem.require_paths = ["lib"]
+  gem.version       = NewClass::VERSION
+
+  gem.add_dependency "activesupport", ">= 3.0.0"
+end

data/script/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "bundler"
+Bundler.require :gem_default, :gem_development
+
+Pry.start

data/test/carrierwave_test.rb

@@ -0,0 +1,105 @@
+require File.expand_path("../test_helper", __FILE__)
+
+require "carrierwave/orm/activerecord"
+
+CarrierWave.root = File.expand_path("../carrierwave_test", __FILE__)
+ActiveRecord::Base.logger = nil
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+ActiveRecord::Schema.define do
+  create_table :users do |table|
+    table.column :avatar, :string
+  end
+end
+
+class CarrierWaveTest < Test::Unit::TestCase
+
+  context "A variable dependent CarrierWave Uploader class" do
+    setup do
+      class Uploader < CarrierWave::Uploader::Base
+        include NewClass
+
+        def self.defined
+          include config[:processor]
+          storage config[:storage]
+
+          config[:versions].each do |v|
+            case v.class.name
+            when "Array"
+              process :resize_to_fit => v
+            when "Hash"
+              version v.keys.first do
+                process :resize_to_fit => v.values.first
+              end
+            end
+          end
+        end
+
+        def store_dir
+          "uploads/#{model.class.name.match(/[^:]+$/).to_s.underscore}/#{mounted_as}/#{model.id}"
+        end
+
+        def cache_dir
+          "tmp"
+        end
+
+        def extension_white_list
+          config[:extension_white_list]
+        end
+      end
+
+      @Uploader = Uploader.new_class({
+        :config => {
+          :processor => CarrierWave::RMagick,
+          :storage => :file,
+          :versions => [[800, 800], {:thumb => [200, 200]}, {:icon => [100, 100]}],
+          :extension_white_list => %w(jpg jpeg gif png)
+        }
+      })
+    end
+
+    should "have respond to image processing methods" do
+      assert @Uploader.respond_to?(:resize_to_fill)
+      assert @Uploader.respond_to?(:resize_to_fit)
+    end
+
+    should "have the expected storage" do
+      assert_equal CarrierWave::Storage::File, @Uploader.storage
+    end
+
+    context "used within an ActiveRecord::Base class" do
+      setup do
+        class User < ActiveRecord::Base; end
+        User.mount_uploader :avatar, @Uploader
+        @user = User.new
+        @user.avatar = File.open(File.expand_path("../carrierwave_test/archan937.png", __FILE__))
+      end
+
+      teardown do
+        FileUtils.rm_rf File.expand_path("../carrierwave_test/uploads", __FILE__)
+        FileUtils.rm_rf File.expand_path("../carrierwave_test/tmp", __FILE__)
+      end
+
+      should "have the expected cache urls" do
+        assert @user.avatar.url.match(/\/tmp\/[^\/]+\/archan937.png/)
+        assert @user.avatar.thumb.url.match(/\/tmp\/[^\/]+\/thumb_archan937.png/)
+        assert @user.avatar.icon.url.match(/\/tmp\/[^\/]+\/icon_archan937.png/)
+      end
+
+      should "have the expected store urls" do
+        @user.save
+        assert @user.avatar.url.match(/\/uploads\/user\/avatar\/1\/archan937.png/)
+        assert @user.avatar.thumb.url.match(/\/uploads\/user\/avatar\/1\/thumb_archan937.png/)
+        assert @user.avatar.icon.url.match(/\/uploads\/user\/avatar\/1\/icon_archan937.png/)
+      end
+
+      should "have the expected versions" do
+        assert_equal([:thumb, :icon], @Uploader.versions.keys)
+      end
+
+      should "have the expected extension white list" do
+        assert_equal %w(jpg jpeg gif png), @user.avatar.extension_white_list
+      end
+    end
+  end
+
+end

data/test/class_test.rb

@@ -0,0 +1,115 @@
+require File.expand_path("../test_helper", __FILE__)
+
+class ClassTest < Test::Unit::TestCase
+
+  context "A class having included NewClass" do
+    setup do
+      class A
+      end
+      class B
+        include NewClass
+      end
+    end
+
+    should "respond to new_class" do
+      assert !A.respond_to?(:new_class)
+      assert B.respond_to?(:new_class)
+    end
+
+    should "be able to return a new class" do
+      assert_equal Class, B.new_class.class
+    end
+
+    context "the new class" do
+      setup do
+        @B = B.new_class
+        @C = B.new_class({}, "C")
+      end
+
+      should "respond to _name and _variables" do
+        assert !A.respond_to?(:_name)
+        assert !A.respond_to?(:_variables)
+
+        assert_equal(B.name, @B._name)
+        assert_equal({}, @B._variables)
+
+        assert_equal("C", @C._name)
+        assert_equal({}, @C._variables)
+      end
+
+      should "override method_missing and respond_to?" do
+        klass = B.new_class "foo" => "bar"
+
+        assert klass.respond_to?(:foo)
+        assert_equal "bar", klass.foo
+
+        assert klass.new.respond_to?(:foo)
+        assert_equal "bar", klass.new.foo
+
+        assert !klass.respond_to?(:bar)
+        assert_raises NoMethodError do
+          klass.bar
+        end
+
+        assert !klass.new.respond_to?(:bar)
+        assert_raises NoMethodError do
+          klass.new.bar
+        end
+      end
+
+      should "be able to create instances" do
+        assert @B.new.is_a?(B)
+        assert_equal B.name, @B.new.class.name
+        assert_equal B.name, @B.new.class.to_s
+
+        assert @C.new.is_a?(B)
+        assert_equal "C", @C.new.class.name
+        assert_equal "C", @C.new.class.to_s
+      end
+    end
+
+    context "and having a superclass" do
+      setup do
+        class Greeter
+          @@translations = {}
+
+          def self.translate(language, translation)
+            @@translations[language.to_sym] = translation
+          end
+          def self.translation(language)
+            @@translations[language.to_sym]
+          end
+          def greet(language = :english)
+            self.class.translation(language).gsub("{class}", self.class.name.match(/[^:]+$/).to_s)
+          end
+
+          translate :english, "Hi, I am a {class}"
+        end
+        class C < Greeter
+          include NewClass
+          def self.defined
+            translations.each do |language, translation|
+              translate language, translation
+            end
+          end
+        end
+      end
+
+      should "behave as expected" do
+        assert_equal "Hi, I am a C", C.new.greet
+      end
+
+      should "have defined called" do
+        @C = C.new_class({:translations => {:dutch => "Hallo, ik ben een {class}"}})
+        @D = C.new_class({:translations => {:dutch => "Hallo, ik ben een {class}"}}, "D")
+
+        assert_equal "Hi, I am a C", @C.new.greet
+        assert_equal "Hallo, ik ben een C", @C.new.greet(:dutch)
+
+        assert_equal "Hi, I am a D", @D.new.greet
+        assert_equal "Hallo, ik ben een D", @D.new.greet(:dutch)
+      end
+    end
+  end
+
+end

data/test/new_class_test.rb

@@ -0,0 +1,11 @@
+require File.expand_path("../test_helper", __FILE__)
+
+class NewClassTest < Test::Unit::TestCase
+
+  context "NewClass module" do
+    should "be defined" do
+      assert defined?(NewClass)
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require "rubygems"
+require "bundler"
+Bundler.require :gem_default, :gem_test

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: new_class
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Paul Engel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-23 00:00:00 +01: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 
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Define variable dependent classes without using class_eval
+email: 
+- paul.engel@holder.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.rdoc
+- Gemfile
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/new_class.rb
+- lib/new_class/version.rb
+- new_class.gemspec
+- script/console
+- test/carrierwave_test.rb
+- test/carrierwave_test/archan937.png
+- test/class_test.rb
+- test/new_class_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/archan937/new_class
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Define variable dependent classes without using class_eval
+test_files: 
+- test/carrierwave_test.rb
+- test/carrierwave_test/archan937.png
+- test/class_test.rb
+- test/new_class_test.rb
+- test/test_helper.rb