acts_as_configuration 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.directory
+*~ 

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in acts_as_configuration.gemspec
+gemspec

data/README

@@ -0,0 +1,164 @@
+# Acts as configuration
+
+This *acts_as* extension provides the capabilities for transform a *string* or *text* column to a configuration variable.
+
+## Installation
+
+<code>gem install acts_as_configuration</code>
+
+### Rails 3
+Add in your Gemfile:
+<code>gem 'acts_as_configuration', :git => 'git://github.com/anga/acts_as_configuration.git'</code>
+
+## Usage
+
+Only you need to add the next line in your model.
+
+<code>acts_as_configuration :configuration</code>
+
+For example:
+
+    class User < ActiveRecord::Base
+      acts_as_configuration :config
+    end
+
+Now you can write your configuration like:
+
+    user.configuration.private_photos = true
+    user.configuration.subscribe_to_news = false
+    user.configuration.perfil_description = ''
+    user.save
+
+### Columns configuration
+
+You can configurate each column.
+
+#### Set column type
+
+You can set the type of the colum.
+
+    class User < ActiveRecord::Base
+      acts_as_configuration :config, :columns => {
+        :private_photos => {
+          :type => :boolean
+        }, :age => {
+          :type => :get_type
+        }, :perfil_description => {
+          :type => lambda {
+            String
+          }
+        }, :last_loggin => {
+          :type => Time.now.class
+        }, :subscribe_to_rss => :get_rss_config
+      }
+
+      protected
+      def get_type
+        Fixnum
+      end
+
+      def get_rss_config
+        {
+          :type => :boolean
+        }
+      end
+    end
+
+You can use any class, but if you need use boolean values, you must use :boolean.
+
+#### Set default value
+
+    class User < ActiveRecord::Base
+      acts_as_configuration :config, :columns => {
+        :private_photos => {
+          :type => :boolean,
+          :default => true
+        }, :age => {
+          :type => :get_type,
+          :default => 1
+        }, :perfil_description => {
+          :type => lambda {
+            String
+          },
+          :default => :get_default_perfil_description
+        }, :last_loggin => {
+          :type => Time.now.class,
+          :default => lambda {
+            self.created_at.time
+          }
+        }, :subscribe_to_rss => :get_rss_config
+      }
+
+      protected
+      def get_type
+        Fixnum
+      end
+
+      def get_rss_config
+        {
+          :type => :boolean,
+          :default => true
+        }
+      end
+
+      def get_default_perfil_description
+        Description.where(:user_id => self.id).default
+      end
+    end
+
+#### Set validation
+    class User < ActiveRecord::Base
+      acts_as_configuration :config, :columns => {
+        :private_photos => {
+          :type => :boolean,
+          :default => true
+        }, :age => {
+          :type => :get_type,
+          :default => 1,
+          :validate => lambda {
+            |age|
+            errors.add :config_age, "You are Matusalén?" if age > 150
+            errors.add :config_age, "You're a fetus?" if age <= 0
+          }
+        }, :perfil_description => {
+          :type => lambda {
+            String
+          },
+          :default => :get_default_perfil_description,
+          :lambda => :must_not_have_strong_language
+        }, :last_loggin => {
+          :type => Time.now.class,
+          :default => lambda {
+            self.created_at.time
+          },
+          :validate => lambda {
+            |time|
+            errors.add :config_last_loggin, "You can't loggin in the future" if time > Time.now
+          }
+        }, :subscribe_to_rss => :get_rss_config
+      }
+
+      protected
+      STRONG_WORD = [
+        #...
+      ]
+      
+      def get_type
+        Fixnum
+      end
+
+      def get_rss_config
+        {
+          :type => :boolean,
+          :default => true
+        }
+      end
+
+      def get_default_perfil_description
+        Description.where(:user_id => self.id).default
+      end
+
+      def must_not_have_strong_language(desc)
+        errors.add :cofig_perfil_description, "You must not have strong language" if desc =~ /(#{STRONG_WORD.join('|')})/
+      end
+    end

data/README.markdown

@@ -0,0 +1,164 @@
+# Acts as configuration
+
+This *acts_as* extension provides the capabilities for transform a *string* or *text* column to a configuration variable.
+
+## Installation
+
+<code>gem install acts_as_configuration</code>
+
+### Rails 3
+Add in your Gemfile:
+<code>gem 'acts_as_configuration', :git => 'git://github.com/anga/acts_as_configuration.git'</code>
+
+## Usage
+
+Only you need to add the next line in your model.
+
+<code>acts_as_configuration :configuration</code>
+
+For example:
+
+    class User < ActiveRecord::Base
+      acts_as_configuration :config
+    end
+
+Now you can write your configuration like:
+
+    user.configuration.private_photos = true
+    user.configuration.subscribe_to_news = false
+    user.configuration.perfil_description = ''
+    user.save
+
+### Columns configuration
+
+You can configurate each column.
+
+#### Set column type
+
+You can set the type of the colum.
+
+    class User < ActiveRecord::Base
+      acts_as_configuration :config, :columns => {
+        :private_photos => {
+          :type => :boolean
+        }, :age => {
+          :type => :get_type
+        }, :perfil_description => {
+          :type => lambda {
+            String
+          }
+        }, :last_loggin => {
+          :type => Time.now.class
+        }, :subscribe_to_rss => :get_rss_config
+      }
+
+      protected
+      def get_type
+        Fixnum
+      end
+
+      def get_rss_config
+        {
+          :type => :boolean
+        }
+      end
+    end
+
+You can use any class, but if you need use boolean values, you must use :boolean.
+
+#### Set default value
+
+    class User < ActiveRecord::Base
+      acts_as_configuration :config, :columns => {
+        :private_photos => {
+          :type => :boolean,
+          :default => true
+        }, :age => {
+          :type => :get_type,
+          :default => 1
+        }, :perfil_description => {
+          :type => lambda {
+            String
+          },
+          :default => :get_default_perfil_description
+        }, :last_loggin => {
+          :type => Time.now.class,
+          :default => lambda {
+            self.created_at.time
+          }
+        }, :subscribe_to_rss => :get_rss_config
+      }
+
+      protected
+      def get_type
+        Fixnum
+      end
+
+      def get_rss_config
+        {
+          :type => :boolean,
+          :default => true
+        }
+      end
+
+      def get_default_perfil_description
+        Description.where(:user_id => self.id).default
+      end
+    end
+
+#### Set validation
+    class User < ActiveRecord::Base
+      acts_as_configuration :config, :columns => {
+        :private_photos => {
+          :type => :boolean,
+          :default => true
+        }, :age => {
+          :type => :get_type,
+          :default => 1,
+          :validate => lambda {
+            |age|
+            errors.add :config_age, "You are Matusalén?" if age > 150
+            errors.add :config_age, "You're a fetus?" if age <= 0
+          }
+        }, :perfil_description => {
+          :type => lambda {
+            String
+          },
+          :default => :get_default_perfil_description,
+          :lambda => :must_not_have_strong_language
+        }, :last_loggin => {
+          :type => Time.now.class,
+          :default => lambda {
+            self.created_at.time
+          },
+          :validate => lambda {
+            |time|
+            errors.add :config_last_loggin, "You can't loggin in the future" if time > Time.now
+          }
+        }, :subscribe_to_rss => :get_rss_config
+      }
+
+      protected
+      STRONG_WORD = [
+        #...
+      ]
+      
+      def get_type
+        Fixnum
+      end
+
+      def get_rss_config
+        {
+          :type => :boolean,
+          :default => true
+        }
+      end
+
+      def get_default_perfil_description
+        Description.where(:user_id => self.id).default
+      end
+
+      def must_not_have_strong_language(desc)
+        errors.add :cofig_perfil_description, "You must not have strong language" if desc =~ /(#{STRONG_WORD.join('|')})/
+      end
+    end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/acts_as_configuration.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_configuration/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_configuration"
+  s.version     = ActsAsConfiguration::VERSION
+  s.authors     = ["Andrés B."]
+  s.email       = ["andres.b.dev@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Make a variable to work like a configuration variable}
+  s.description = %q{Make a variable to work like a configuration variable}
+
+  s.rubyforge_project = "acts_as_configuration"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/acts_as_configuration/version.rb

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

data/lib/acts_as_configuration.rb

@@ -0,0 +1,336 @@
+# encoding: utf-8
+require "acts_as_configuration/version"
+
+module ActsAsConfiguration
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # The object how controll the data
+  class Configuration
+    def initialize(options={})
+      @model = options[:model]
+      @column_name = options[:column_name].to_s
+      @columns = expand_options options[:columns], { :not_call_symbol => [:boolean], :not_expand => [:validate, :default] }
+      @value = get_defaults_values options
+
+      raise "#{@column_name} should by text or string not #{options[:model].column_for_attribute(@column_name.to_sym).type}" if not [:text, :stiring].include? options[:model].column_for_attribute(@column_name.to_sym).type
+
+      out = YAML.parse(@model[@column_name].to_s)
+      if out == false
+        db_value = nil
+      else
+        db_value = out.to_ruby
+      end
+      @value.merge! db_value if db_value.kind_of? Hash
+
+      initialize_values
+
+      # Raise or not if fail?...
+      @model.attributes[@column_name] = @value
+      @model.save(:validate => false)
+    end
+
+    def [](key)
+      @value[key.to_s]
+    end
+
+    def []=(key, value)
+      if  (@columns[key.to_sym][:type] == :boolean and (not [true.class, false.class].include? value.class)) or
+          ((not [:boolean, nil].include?(@columns[key.to_sym][:type])) and @columns[key.to_sym][:type] != value.class )
+        raise "#{value.inspect} is not a valid type, expected #{@columns[key.to_sym][:type]}"
+      end
+      @value[key.to_s] = value
+      @model.send :"#{@column_name}=", @value.to_yaml
+    end
+
+    # The "magic" happen here.
+    # Use the undefined method as a column
+    def method_missing(m, *args, &block)
+      # If the method don't finish in "=" is fore read
+      if m !~ /\=$/
+        self[m.to_s]
+      # but if finish with "=" is for wirte
+      else
+        column_name = m.to_s.gsub(/\=$/, '')
+        self[column_name.to_s] = args.first
+      end
+    end
+
+    private
+
+    def initialize_values
+      if not @value.kind_of? Hash
+        @model.attributes[@column_name] = {}.to_yaml
+        @model.save
+      end
+    end
+
+    def get_defaults_values(options = {})
+      defaults_ = {}
+      options[:columns].each do |column, config|
+        defaults_[column.to_s] = @columns[column.to_sym][:default] || nil
+      end
+      defaults_
+    end
+
+    # Only we accept strings as key
+    def transform_defaults(hash)
+      _hash = {}
+      hash.each do |key, value|
+        _hash[key.to_s] = value
+      end
+      _hash
+    end
+
+    def expand_options(options={}, opts={})
+      config_opts = {
+        :not_expand => [],
+        :not_call_symbol => []
+      }.merge! opts
+      if options.kind_of? Hash
+        opts = {}
+        options.each do |column, config|
+          if not config_opts[:not_expand].include? column.to_sym
+            if not config_opts[:not_call_symbol].include? config
+              opts[column.to_sym] = expand_options(get_value_of(config), config_opts)
+            else
+              opts[column.to_sym] = expand_options(config, config_opts)
+            end
+          else
+            opts[column.to_sym] = config
+          end
+        end
+        return opts
+      else
+        return get_value_of options
+      end
+    end
+
+    def get_value_of(value)
+      if value.kind_of? Symbol
+        # If the function exist, we execute it
+        if  @model.respond_to? value
+          return @model.send value
+        # if the the function not exist, whe set te symbol as a value
+        else
+          return value
+        end
+      elsif value.kind_of? Proc
+        return value.call
+      else
+        return value
+      end
+    end
+  end
+
+  module ClassMethods
+    def acts_as_configuration(column_name, options = {})
+      cattr_accessor :aac_columns_config
+      self.aac_columns_config = self.aac_columns_config || {}
+
+      # Parse options
+      # Definir attr_accessor
+      # definir cattr_accessor
+      # Realizar un include que redefina el initialize
+      # Ver https://github.com/Caseproof/metafy/blob/master/lib/metafy/activerecord_methods.rb
+
+      # Para ver que hacer en el initialize ver:
+      # https://github.com/Caseproof/metafy/blob/master/lib/metafy/base.rb
+
+      assign_attributes_eval = "
+      def assign_attributes(attributes = nil, options = {})
+        attributes.each_pair do |key, value|
+          puts key
+          if key.to_s =~ /^#{column_name}_/
+            puts key
+            rb = \"#{column_name}.\#\{key.to_s.gsub(/^#{column_name}_/,'')\}\"
+            eval rb, binding
+          end
+        end
+        attributes.delete_if do |key,value|
+          key.to_s =~ /^#{column_name}_/
+        end
+        super attributes, options
+      end
+      "
+      
+      class_eval <<-EOV
+      public
+        validate :aac_validations
+
+        puts "Evaluando de: \#\{self.name}"
+        (eval self.name).class_eval <<-EOS
+          def assign_attributes(attributes = nil, options = {})
+            attributes.each_pair do |key, value|
+              puts key
+              if key.to_s =~ /^#{column_name}_/
+                puts key
+                rb = \"#{column_name}.\#\{key.to_s.gsub(/^#{column_name}_/,'')\}\"
+                eval rb, binding
+              end
+            end
+            attributes.delete_if do |key,value|
+              key.to_s =~ /^#{column_name}_/
+            end
+            super attributes, options
+          end
+        EOS
+
+        def #{column_name.to_s}
+          if not @#{column_name.to_s}_configuration.kind_of? ActsAsConfiguration::Configuration
+            opts = initialize_options(#{options})
+            options = {
+                :extensible => true    # If is false, only the columns defined in :columns can be used
+              }.merge! opts
+            columns = initialize_columns expand_options(options, { :not_call_symbol => [:boolean], :not_expand => [:validate, :default] })
+            @#{column_name.to_s}_configuration ||= ActsAsConfiguration::Configuration.new({:model => self, :column_name => :#{column_name.to_s}, :columns => columns})
+          end
+          @#{column_name.to_s}_configuration
+        end
+
+      protected
+        def aac_validations
+          @aac_validation ||= {} if not @aac_validation.kind_of? Hash
+          @aac_validation.each do |column, validation|
+            if validation.kind_of? Symbol
+              self.send validation, eval("@#{column_name.to_s}_configuration.\#\{column.to_s\}")
+            elsif validation.kind_of? Proc
+              validation.call @#{column_name.to_s}_configuration[column.to_sym]
+            end
+          end
+        end
+
+        def initialize_options(options={})
+          opts = expand_options options, { :not_call_symbol => [:boolean], :not_expand => [:validate, :default] }
+        end
+
+        # Initialize each column configuration
+        def initialize_columns(options = {})
+          columns = {}
+          if options[:columns].kind_of? Hash
+            options[:columns].each do |column, config|
+              columns[column] = initialize_column column, config
+            end
+          elsif options[:columns].kind_of? Symbol
+            hash =  self.send options[:columns]
+            raise "Invalid columns configuration" if not hash.kind_of? Hash
+            columns = initialize_columns :columns => hash
+          elsif options[:columns].kind_of? Proc
+            hash = options[:columns].call
+            raise "Invalid columns configuration" if not hash.kind_of? Hash
+            columns = initialize_columns :columns => hash
+          end
+          columns
+        end
+
+        def initialize_column(column,config={})
+          raise "The column \#\{column\} have an invalid configuration (\#\{config.class\} => \#\{config\})" if not config.kind_of? Hash
+          column = column.to_sym
+          column_config = {}
+
+          # Stablish the type
+          if config[:type].class == Class
+            # If exist :type, is a static column
+            column_config[:type] = config[:type]
+          else
+            # if not, is a dynamic column
+            if config[:type].to_sym == :any
+              column_config[:type] = nil
+            elsif config[:type].to_sym == :boolean
+              column_config[:type] = :boolean
+            else
+              raise "\#\{config[:type]\} is not a valid column type"
+            end
+          end
+
+          # Stablish the default value
+          # if is a symbol, we execute the function from the model
+          if config[:default].kind_of? Symbol
+            column_config[:default] = self.send(:config[:default])
+          elsif config[:default].kind_of? Proc
+            column_config[:default] = config[:default].call
+          else
+            # If the column have a type, we verify the type
+            if not column_config[:type].nil?
+              if  (column_config[:type] == :boolean and (not [true.class, false.class].include? config[:default].class)) or
+                  ((not [:boolean, nil].include?(column_config[:type])) and column_config[:type] != config[:default].class )
+                  raise "The column \#\{column\} has an invalid default value. Expected \#\{column_config[:type]}, not \#\{config[:default].class}"
+              end
+              column_config[:default] = config[:default]
+            else
+              # If is dynamic, only we set the default value
+              column_config[:default] = config[:default]
+            end
+          end
+
+          # Set the validation
+          if [Symbol, Proc].include? config[:validate].class
+            column_config[:validate] = config[:validate]
+            create_validation_for column, config[:validate]
+          else
+            raise "The validation of \#\{column\} is invalid"
+          end
+
+
+          column_config
+        end
+
+        def create_validation_for(column, validation)
+          column = column.to_sym
+          @aac_validation ||= {}
+          @aac_validation[column] = validation
+        end
+
+        def expand_options(options={}, opts={})
+          config_opts = {
+            :not_expand => [],
+            :not_call_symbol => []
+          }.merge! opts
+          if options.kind_of? Hash
+            opts = {}
+            options.each do |column, config|
+              if not config_opts[:not_expand].include? column.to_sym
+                if not config_opts[:not_call_symbol].include? config
+                  opts[column.to_sym] = expand_options(get_value_of(config), config_opts)
+                else
+                  opts[column.to_sym] = expand_options(config, config_opts)
+                end
+              else
+                opts[column.to_sym] = config
+              end
+            end
+            return opts
+          else
+            return get_value_of options
+          end
+        end
+
+        def get_value_of(value)
+          if value.kind_of? Symbol
+            # If the function exist, we execute it
+            if  self.respond_to? value
+              return self.send value
+            # if the the function not exist, whe set te symbol as a value
+            else
+              return value
+            end
+          elsif value.kind_of? Proc
+            return value.call
+          else
+            return value
+          end
+        end
+      EOV
+      
+    end
+
+    
+
+    protected
+
+
+  end
+end
+
+ActiveRecord::Base.class_eval { include ActsAsConfiguration }

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_configuration
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrés B.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &5405980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *5405980
+description: Make a variable to work like a configuration variable
+email:
+- andres.b.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README
+- README.markdown
+- Rakefile
+- acts_as_configuration.gemspec
+- lib/acts_as_configuration.rb
+- lib/acts_as_configuration/version.rb
+homepage: ''
+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: acts_as_configuration
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Make a variable to work like a configuration variable
+test_files: []