appsent 0.0.3 → 0.0.4

data/README.md

@@ -20,13 +20,13 @@ Initialize application with config requirements:
 
 	  # Hash-based config:
 	  mongo_db_config do
-	    host      :type => String, :example => 'localhost', :desc => 'Host to connect to MongoDB'
-	    port      :type => Fixnum
-	    pool_size :type => Fixnum
-	    timeout   :type => Fixnum
+	    host      String, 'Host to connect to MongoDB' => 'localhost'
+	    port      Fixnum, 'Port to connect to MongoDB'
+	    pool_size Fixnum
+	    timeout   Fixnum
 	  end
 
-	  exception_notification_recipients :type => Array
+	  exception_notification_recipients Array
 
 	end
 

data/Rakefile

@@ -6,7 +6,17 @@ Bundler::GemHelper.install_tasks
 
 task :default => [:spec, :features]
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts='--tag ~wip'
+end
+
+namespace :spec do
+
+  RSpec::Core::RakeTask.new(:wip) do |t|
+    t.rspec_opts='--tag wip'
+  end
+
+end
 
 Cucumber::Rake::Task.new(:features) do |t|
   t.profile = 'default'

data/features/README.md

@@ -20,13 +20,13 @@ Initialize application with config requirements:
 
 	  # Hash-based config:
 	  mongo_db_config do
-	    host      :type => String, :example => 'localhost', :desc => 'Host to connect to MongoDB'
-	    port      :type => Fixnum
-	    pool_size :type => Fixnum
-	    timeout   :type => Fixnum
+	    host      String, 'Host to connect to MongoDB' => 'localhost'
+	    port      Fixnum, 'Port to connect to MongoDB'
+	    pool_size Fixnum
+	    timeout   Fixnum
 	  end
 
-	  exception_notification_recipients :type => Array
+	  exception_notification_recipients Array
 
 	end
 

data/features/array_with_nested_params.feature

@@ -9,12 +9,12 @@ Feature: Array with nested params
     AppSent.init :path => 'config', :env => 'production' do
 
       mongodb do
-        host      :type => String, :example => 'localhost', :desc => 'Host to connect to MongoDB'
-        port      :type => Fixnum, :example => 27017,       :desc => 'MongoDB port'
+        host      String, 'Host to connect to MongoDB' => 'localhost'
+        port      Fixnum, 'MongoDB port'               => 27017
 
-        slaves :type => Array do
-          host    :type => String, :example => 'host.com', :desc => 'mongo slave host'
-          port    :type => Fixnum, :example => 27018,      :desc => 'mongo slave port'
+        slaves Array do
+          host    String, 'mongo slave host' => 'host.com'
+          port    Fixnum, 'mongo slave port' => 27018
         end
       end
 

data/features/full_example.feature

@@ -9,20 +9,20 @@ Feature: Complex usage
       system_config do
 
         google_analytics do
-          code              :type => String, :example => 'UA-12345678-1', :desc => 'Enter your google analytics code here'
-          multiple_domains  :type => String, :desc => 'has multiple domains?'
-          domain            :type => String, :example => 'example.com', :desc => 'your domain'
+          code              String, 'Enter your google analytics code here' => 'UA-12345678-1'
+          multiple_domains  String, 'has multiple domains?'
+          domain            String, 'your domain' => 'example.com'
         end
 
-        system_email :type => String, :example => 'admin@example.com'
+        system_email String, :example => 'admin@example.com'
 
       end
 
       mongodb do
-        host      :type => String, :example => 'localhost', :desc => 'Host to connect to MongoDB'
-        port      :type => Fixnum, :example => 27017,       :desc => 'MongoDB port'
-        pool_size :type => Fixnum
-        timeout   :type => Fixnum
+        host       String, 'Host to connect to MongoDB' => 'localhost'
+        port       Fixnum, 'MongoDB port' => 27017
+        pool_size  Fixnum
+        timeout    Fixnum
       end
 
     end
@@ -31,14 +31,14 @@ Feature: Complex usage
     """
       # TODO:
       #recaptcha :skip_env => true do
-      #  recaptcha_public_key  :type => String, :desc => 'Recaptcha public key'
-      #  recaptcha_private_key :type => String, :desc => 'Recaptcha private key'
+      #  recaptcha_public_key  String, 'Recaptcha public key'
+      #  recaptcha_private_key String, 'Recaptcha private key'
       #end
-      #notification_recipients :type => Array, :skip_env => true, :each_value => TODO
+      #notification_recipients Array, :skip_env => true, :each_value => TODO
       #
       #        slaves :type => Array do
-      #          host    :type => String, :example => 'host.com', :desc => 'mongo slave host'
-      #          port    :type => Fixnum, :example => 27018,      :desc => 'mongo slave port'
+      #          host String, 'mongo slave host' => 'host.com'
+      #          port Fixnum, 'mongo slave port' => 27018
       #        end
 
   Scenario: All config present and have right values

data/features/simple_usage.feature

@@ -7,8 +7,8 @@ Feature: Simple usage example
 
     AppSent.init :path => 'config', :env => 'production' do
       mongodb do
-        host  :type => String, :example => 'localhost', :desc => 'Host to connect to MongoDB'
-        port  :type => Fixnum, :example => 27017,       :desc => 'MongoDB port'
+        host  String, 'Host to connect to MongoDB' => 'localhost'
+        port  Fixnum, 'MongoDB port'               => 27017
       end
     end
 

data/features/with_nested_params.feature

@@ -9,9 +9,9 @@ Feature: Usage with nested params example
       system_config do
 
         google_analytics do
-          code              :type => String, :example => 'UA-12345678-1', :desc => 'Enter your google analytics code here'
-          multiple_domains  :type => String, :desc => 'has multiple domains?'
-          domain            :type => String, :example => 'example.com', :desc => 'your domain'
+          code              String, 'Enter your google analytics code here' => 'UA-12345678-1'
+          multiple_domains  String, 'has multiple domains?'
+          domain            String, 'your domain' => 'example.com'
         end
 
       end

data/lib/appsent.rb

@@ -63,10 +63,10 @@ class AppSent
 
   private
 
-  def method_missing config, args={}, &block
+  def method_missing config, *args, &block
     config = config.to_s
     @@config_files << config
-    @configs << ConfigFile.new(@@config_path,config,@@environment,args[:type],&block)
+    @configs << ConfigFile.new(@@config_path,config,@@environment,*args,&block)
   end
 
 end

data/lib/appsent/config_file.rb

@@ -6,10 +6,11 @@ class AppSent
     ENVIRONMENT_NOT_FOUND_ERROR_MSG = "config file '%s' has no '%s' environment"
     WRONG_CONFIG_ERROR_MSG          = "wrong config file '%s':\n"
 
-    def initialize config_dir, config_file_name, environment, type, &block
-      @config_dir, @config_file_name, @environment, @type, @block = config_dir, config_file_name, (environment && environment.to_sym), type, block
+    def initialize config_dir, config_file_name, environment, *opts, &block
+      @config_dir, @config_file_name, @environment, @block = config_dir, config_file_name, (environment && environment.to_sym), block
 
-      @type ||= Hash
+      @type = opts.empty? ? Hash : opts.first
+      @type = @type[:type] if @type.is_a?(Hash)
       raise "params #{@type} and block given" if block_given? and not @type==Hash
       @path_to_config = File.join(@config_dir,@config_file_name+'.yml')
       @self_error_msg = ''
@@ -65,8 +66,8 @@ class AppSent
       @path_to_config.gsub(Dir.pwd+File::SEPARATOR,'')
     end
 
-    def method_missing option, opts={}, &block
-      self.options << ConfigValue.new(option.to_s, opts[:type], @data[option.to_sym], opts[:desc], opts[:example], &block)
+    def method_missing option, *args, &block
+      self.options << ConfigValue.new(option.to_s, @data[option.to_sym], *args, &block)
     end
 
   end

data/lib/appsent/config_value.rb

@@ -10,8 +10,31 @@ class AppSent
     WRONG_CHILD_OPTIONS_MSG    = "wrong nested parameters"
 
     # data => it's an actual data of parameter
-    def initialize parameter, data_type, data, description, example, &block
-      @parameter, @data_type, @data, @description, @example = (parameter and parameter.to_sym), data_type, data, description, example
+    def initialize parameter, data, *opts, &block
+      @parameter, @data = (parameter and parameter.to_sym), data
+
+      if opts.size==1
+        opts = opts.first
+        begin
+          %w( type desc example ).each do |deprecated_key|
+            warn("AppSent DEPRECATION WARNING: :#{deprecated_key} is deprecated and will be removed in a future major release, go to online documentation and see how to define config values") if opts.has_key?(deprecated_key.to_sym)
+          end
+
+          @data_type, @description, @example = opts[:type], opts[:desc], opts[:example]
+        rescue NoMethodError# opts is a [String]
+          @data_type = opts
+        end
+      else
+        @data_type = opts.delete_at(0)
+        description_and_example = opts.delete_at(0)
+        case description_and_example
+        when String
+          @description = description_and_example
+        when Hash
+          @description = description_and_example.keys.first
+          @example = description_and_example.values.first
+        end
+      end
 
       @data_type ||= Hash
       raise WRONG_DATA_TYPE_PASSED_MSG unless @data_type.is_a?(Class)
@@ -83,13 +106,12 @@ class AppSent
 
     private
 
-    def method_missing option, opts={}
+    def method_missing option, *opts, &block
       self.child_options << self.class.new(
 	option.to_s,
-	opts[:type],
 	data[option.to_sym],
-	opts[:desc],
-	opts[:example]
+	*opts,
+        &block
       )
       self.child_options.last.nesting+=(self.nesting+1)
     end

data/lib/appsent/version.rb

@@ -1,3 +1,3 @@
 class AppSent
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/{internal_api → appsent}/config_file_spec.rb

@@ -30,6 +30,76 @@ describe AppSent::ConfigFile do
       it { subject.new(*params).should respond_to(method)}
     end
 
+    context "should send right variables to AppSent::ConfigValue" do
+
+      let(:mock_config_value) { mock(AppSent::ConfigValue, :valid? => true) }
+
+      it "in a simple case" do
+        AppSent::ConfigValue.should_receive(:new).once.with(
+          'username',
+          'user', # data
+          String
+        ).and_return(mock_config_value)
+
+        AppSent.init(:path => '../fixtures', :env => 'test') do
+          database do
+            username String
+          end
+        end
+      end
+
+      it "with a &block" do
+        block = lambda {}
+        AppSent::ConfigValue.should_receive(:new).once.with(
+          'username',
+          'user', # data
+          String,
+          &block
+        ).and_return(mock_config_value)
+
+        AppSent.init(:path => '../fixtures', :env => 'test') do
+          database do
+            username String, &block
+          end
+        end
+      end
+
+      it "with description" do
+        AppSent::ConfigValue.should_receive(:new).once.with(
+          'username',
+          'user', # data
+          String,
+          'description'
+        ).and_return(mock_config_value)
+
+        AppSent.init(:path => '../fixtures', :env => 'test') do
+          database do
+            username String, 'description'
+          end
+        end
+      end
+
+      it "with description and example" do
+        AppSent::ConfigValue.should_receive(:new).once.with(
+          'username',
+          'user', # data
+          String,
+          'description' => 'user'
+        ).and_return(mock_config_value)
+
+        AppSent.init(:path => '../fixtures', :env => 'test') do
+          database do
+            username String, 'description' => 'user'
+          end
+        end
+      end
+
+    end
+
+    after :each do
+      AppSent.send :remove_const, 'DATABASE' if AppSent.const_defined?("DATABASE")
+    end
+
   end
 
   context "#valid?" do
@@ -49,7 +119,7 @@ describe AppSent::ConfigFile do
 
       it "if config exists and environment presence(with values)" do
 	values_block = lambda {
-	  value :type => String
+	  value String
 	}
 	YAML.should_receive(:load_file).once.with(fake_config_filename).and_return('environment' => {:value=>'100500'})
 	subject.new(*params,&values_block).should be_valid

data/spec/appsent/config_value_spec.rb

@@ -0,0 +1,234 @@
+require 'spec_helper'
+
+describe AppSent::ConfigValue do
+
+  subject { described_class }
+
+  before :each do
+    @params = {
+      'name'    => 'param_name',
+      'type'    =>  String,
+      'value'   => 'some string',
+      'desc'    => 'description string',
+      'example' => 'example'
+    }
+  end
+
+  let(:params) do
+    result = [
+      @params['name'],
+      @params['value'],
+      @params['type']
+    ]
+    if @params.has_key?('example')
+      result << { @params['desc'] => @params['example'] }
+    else
+      result << @params['desc']
+    end
+    result
+  end
+
+  context ".new" do
+
+    %w(valid? child_options error_message).each do |method|
+      it { subject.new(*params).should respond_to(method)}
+    end
+
+    it "should raise exception if unsupported type passed" do
+      @params['type'] = 'asd'
+      expect { subject.new(*params) }.to raise_exception(/data type should be ruby class!/)
+    end
+
+    context "with &block given" do
+
+      let(:block) do
+	lambda { value String }
+      end
+
+      it "should not raise exception if data type is Array" do
+	@params['type'] = Array
+	expect { subject.new(*params,&block) }.to_not raise_exception(/params Array and block given/)
+      end
+
+      it "should not raise exception if data type is Hash" do
+	@params['type'] = Hash
+	expect { subject.new(*params,&block) }.to_not raise_exception(/params Hash and block given/)
+      end
+
+      it "should raise exception if data type is not Hash" do
+	@params['type'] = Fixnum
+	expect { subject.new(*params,&block) }.to raise_exception(/params Fixnum and block given/)
+      end
+
+    end
+
+  end
+
+  context "#valid?" do
+
+    context "should return false" do
+
+      it "if entry does not presence in config file" do
+        @params['value']=nil
+	subject.new(*params).should_not be_valid
+      end
+
+      it "if data in config file has wrong type" do
+        @params['type']=Array
+        @params['value']='string'
+	subject.new(*params).should_not be_valid
+      end
+
+      it "if child value is not valid" do
+	@params['type']=Hash
+	@params['value']={:value => 100500}
+	values_block = lambda {
+	  value String
+	}
+	subject.new(*params,&values_block).should_not be_valid
+      end
+
+      context "with type => Array", :wip => true do
+
+	it "if actual data is not array" do
+	  @params['type']=Array
+	  @params['value']=123
+	  subject.new(*params).should_not be_valid
+	end
+
+	it "if actual data is an array of wrong hashes" do
+	  @params['type']=Array
+	  @params['value']=[1,2]
+	  values_block = lambda {
+	    value1 String
+	    value2 Fixnum
+	  }
+	  subject.new(*params,&values_block).should_not be_valid
+	end
+
+      end
+
+    end
+
+    context "should return true" do
+
+      it "if entry presence and has right type" do
+	subject.new(*params).should be_valid
+      end
+
+      it "if valid itself and child values valid too" do
+	@params['type']=Hash
+	@params['value']={'value' => 'some data'}
+	values_block = lambda {
+	  value String
+	}
+	subject.new(*params,&values_block).should be_valid
+      end
+
+      context "with type => Array", :wip => true do
+
+	it "if actual data is an array of right hashes" do
+	  @params['type']=Array
+	  @params['value']=[
+	    {'value1' =>'qwe', 'value2' => 123 },
+	    {'value1' =>'rty', 'value2' => 456 }
+	  ]
+	  values_block = lambda {
+	    value1 String
+	    value2 Fixnum
+	  }
+	  subject.new(*params,&values_block).should be_valid
+	end
+
+      end
+
+    end
+
+  end
+
+  context "#error_message" do
+
+    subject { described_class.new(*params) }
+
+    context "should generate correct error message when no data" do
+
+      it "with full description" do
+        @params['name'] = 'database'
+        @params['value'] = nil
+        @params['type'] = String
+        @params['desc'] = 'Database name'
+        @params['example'] = 'localhost'
+        subject.error_message.should eq("  database: localhost # does not exists(Database name), String")
+      end
+
+      it "without example value" do
+        @params['name'] = 'database'
+        @params['value'] = nil
+        @params['type'] = String
+        @params['desc'] = 'Database name'
+        @params.delete('example')
+        subject.error_message.should eq("  database:  # does not exists(Database name), String")
+      end
+
+      it "without description" do
+        @params['name'] = 'database'
+        @params['value'] = nil
+        @params['type'] = String
+        @params.delete('desc')
+        @params['example'] = 'localhost'
+        subject.error_message.should eq("  database: localhost # does not exists, String")
+      end
+
+      it "without example and description" do
+        @params['name'] = 'database'
+        @params['value'] = nil
+        @params['type'] = String
+        @params.delete('desc')
+        @params.delete('example')
+        subject.error_message.should eq("  database:  # does not exists, String")
+      end
+
+    end
+
+    context "should generate correct error message when data is of wrong type" do
+
+      it "with full description" do
+        @params['name'] = 'database'
+        @params['value'] = 20
+        @params['type'] = String
+        @params['desc'] = 'Database name'
+        @params['example'] = 'localhost'
+        subject.error_message.should eq("  database: 20 # wrong type,should be String(Database name)")
+      end
+
+      it "without example value" do
+        @params['name'] = 'database'
+        @params['value'] = 20
+        @params['type'] = String
+        @params['desc'] = 'Database name'
+        @params.delete('example')
+        subject.error_message.should eq("  database: 20 # wrong type,should be String(Database name)")
+      end
+
+      it "without description" do
+        @params['name'] = 'database'
+        @params['value'] = 20
+        @params['type'] = String
+        @params.delete('desc')
+        @params['example'] = 'localhost'
+        subject.error_message.should eq("  database: 20 # wrong type,should be String")
+      end
+
+      it "without example and description" do
+        @params['name'] = 'database'
+        @params['value'] = 20
+        @params['type'] = String
+        @params.delete('desc')
+        @params.delete('example')
+        subject.error_message.should eq("  database: 20 # wrong type,should be String")
+      end
+
+    end
+
+  end
+end