oscillator 0.0.2 → 0.0.3

data/lib/oscillator.rb

@@ -1,6 +1,6 @@
 require 'oscillator/version'
-require 'oscillator/file_size_validator'
-require 'oscillator/canonical_uploader_path'
+require 'oscillator/validations'
+require 'oscillator/file_location_resolver'
 
 module Oscillator
 end

data/lib/oscillator/file_location_resolver.rb

@@ -0,0 +1,11 @@
+module Oscillator
+  module FileLocationResolver
+    def filename
+      "#{mounted_as}.#{file.extension.downcase}" if @filename
+    end
+
+    def store_dir
+      "#{model.class.name.underscore}/#{model.id}"
+    end
+  end
+end

data/lib/oscillator/file_size_validator.rb

@@ -1,68 +1,70 @@
-# lib/file_size_validator.rb
 # Based on: https://gist.github.com/795665
+require 'singleton'
 
-class FileSizeValidator < ActiveModel::EachValidator
-  MESSAGES  = { :is => :wrong_size, :minimum => :size_too_small, :maximum => :size_too_big }.freeze
-  CHECKS    = { :is => :==, :minimum => :>=, :maximum => :<= }.freeze
+module Oscillator
+  class FileSizeValidator < ActiveModel::EachValidator
+    MESSAGES  = { :is => :wrong_size, :minimum => :size_too_small, :maximum => :size_too_big }.freeze
+    CHECKS    = { :is => :==, :minimum => :>=, :maximum => :<= }.freeze
 
-  DEFAULT_TOKENIZER = lambda { |value| value.split(//) }
-  RESERVED_OPTIONS  = [:minimum, :maximum, :within, :is, :tokenizer, :too_short, :too_long]
+    DEFAULT_TOKENIZER = lambda { |value| value.split(//) }
+    RESERVED_OPTIONS  = [:minimum, :maximum, :within, :is, :tokenizer, :too_short, :too_long]
 
-  def initialize(options)
-    if range = (options.delete(:in) || options.delete(:within))
-      raise ArgumentError, ":in and :within must be a Range" unless range.is_a?(Range)
-      options[:minimum], options[:maximum] = range.begin, range.end
-      options[:maximum] -= 1 if range.exclude_end?
-    end
+    def initialize(options)
+      if range = (options.delete(:in) || options.delete(:within))
+        raise ArgumentError, ":in and :within must be a Range" unless range.is_a?(Range)
+        options[:minimum], options[:maximum] = range.begin, range.end
+        options[:maximum] -= 1 if range.exclude_end?
+      end
 
-    super
-  end
+      super
+    end
 
-  def check_validity!
-    keys = CHECKS.keys & options.keys
+    def check_validity!
+      keys = CHECKS.keys & options.keys
 
-    if keys.empty?
-      raise ArgumentError, 'Range unspecified. Specify the :within, :maximum, :minimum, or :is option.'
-    end
+      if keys.empty?
+        raise ArgumentError, 'Range unspecified. Specify the :within, :maximum, :minimum, or :is option.'
+      end
 
-    keys.each do |key|
-      value = options[key]
+      keys.each do |key|
+        value = options[key]
 
-      unless value.is_a?(Integer) && value >= 0
-        raise ArgumentError, ":#{key} must be a nonnegative Integer"
+        unless value.is_a?(Integer) && value >= 0
+          raise ArgumentError, ":#{key} must be a nonnegative Integer"
+        end
       end
     end
-  end
 
-  def validate_each(record, attribute, value)
-    raise(ArgumentError, "A CarrierWave::Uploader::Base object was expected") unless value.kind_of? CarrierWave::Uploader::Base
+    def validate_each(record, attribute, value)
+      raise(ArgumentError, "A CarrierWave::Uploader::Base object was expected") unless value.kind_of? CarrierWave::Uploader::Base
 
-    value = (options[:tokenizer] || DEFAULT_TOKENIZER).call(value) if value.kind_of?(String)
+      value = (options[:tokenizer] || DEFAULT_TOKENIZER).call(value) if value.kind_of?(String)
 
-    CHECKS.each do |key, validity_check|
-      next unless check_value = options[key]
+      CHECKS.each do |key, validity_check|
+        next unless check_value = options[key]
 
-      value ||= [] if key == :maximum
+        value ||= [] if key == :maximum
 
-      value_size = value.size
-      next if value_size.send(validity_check, check_value)
+        value_size = value.size
+        next if value_size.send(validity_check, check_value)
 
-      errors_options = options.except(*RESERVED_OPTIONS)
-      errors_options[:file_size] = help.number_to_human_size check_value
+        errors_options = options.except(*RESERVED_OPTIONS)
+        errors_options[:file_size] = help.number_to_human_size check_value
 
-      default_message = options[MESSAGES[key]]
-      errors_options[:message] ||= default_message if default_message
+        default_message = options[MESSAGES[key]]
+        errors_options[:message] ||= default_message if default_message
 
-      record.errors.add(attribute, MESSAGES[key], errors_options)
+        record.errors.add(attribute, MESSAGES[key], errors_options)
+      end
     end
-  end
 
-  def help
-    Helper.instance
-  end
+    def help
+      Helper.instance
+    end
 
-  class Helper
-    include Singleton
-    include ActionView::Helpers::NumberHelper
+    class Helper
+      include ::Singleton
+      include ::ActionView::Helpers::NumberHelper
+    end
   end
 end

data/lib/oscillator/validations.rb

@@ -0,0 +1 @@
+require 'oscillator/file_size_validator'

data/lib/oscillator/version.rb

@@ -1,3 +1,3 @@
 module Oscillator
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/file_location_resolver_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+class ResolvableUploader < CarrierWave::Uploader::Base
+  include Oscillator::FileLocationResolver
+end
+
+class MyModel
+  def id
+    123
+  end
+end
+
+describe Oscillator::FileLocationResolver, :carrier_wave do
+  let(:model)    { MyModel.new                             }
+  let(:uploader) { ResolvableUploader.new model, :resolver }
+
+  describe '#filename' do
+    context 'when a file has been stored' do
+      before { uploader.store! File.open(@test_image_directory + 'SMALL-LOGO-SHORT-AND-WIDE.PNG') }
+
+      it 'is the mounted as name along with the lowercase file extension' do
+        uploader.filename.should eql 'resolver.png'
+      end
+    end
+
+    context 'when a file has not been stored' do
+      it 'is nil' do
+        uploader.filename.should be_nil
+      end
+    end
+  end
+
+  describe '#store_dir' do
+    it 'is the underscored class name followed by a subfolder for the ID of the model' do
+      uploader.store_dir.should eql 'my_model/123'
+    end
+  end
+end

data/spec/file_size_validator_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+
+class ImageUploader < CarrierWave::Uploader::Base
+end
+
+class ValidatableClassWithMinimum
+  include ActiveModel::Validations
+  extend  CarrierWave::Mount
+
+  attr_accessor   :image
+
+  mount_uploader  :image
+
+  validates       :image,
+                    :'oscillator/file_size' => {
+                      minimum:    2 }
+end
+
+class ValidatableClassWithMaximum
+  include ActiveModel::Validations
+  extend  CarrierWave::Mount
+
+  attr_accessor   :image
+
+  mount_uploader  :image
+
+  validates       :image,
+                    :'oscillator/file_size' => {
+                      maximum:    2 }
+end
+
+class ValidatableClassWithWithin
+  include ActiveModel::Validations
+  extend  CarrierWave::Mount
+
+  attr_accessor   :image
+
+  mount_uploader  :image
+
+  validates       :image,
+                    :'oscillator/file_size' => {
+                      within:    2..4 }
+end
+
+class ValidatableClassWithIs
+  include ActiveModel::Validations
+  extend  CarrierWave::Mount
+
+  attr_accessor   :image
+
+  mount_uploader  :image
+
+  validates       :image,
+                    :'oscillator/file_size' => {
+                      is:       2 }
+end
+
+describe Oscillator::FileSizeValidator, :carrier_wave do
+  describe '#valid?' do
+    context 'when a `minimum` is set' do
+      let(:validatable) { ValidatableClassWithMinimum.new }
+
+      context 'and a file lower than the minimum is stored' do
+        before { validatable.image.store! File.open(@test_image_directory + '0-byte-file.txt') }
+
+        it 'is false' do
+          validatable.should_not be_valid
+        end
+      end
+
+      context 'and a file the same as the minimum is stored' do
+        before { validatable.image.store! File.open(@test_image_directory + '2-byte-file.txt') }
+
+        it 'is true' do
+          validatable.should be_valid
+        end
+      end
+    end
+
+    context 'when a `maximum` is set' do
+      let(:validatable) { ValidatableClassWithMaximum.new }
+
+      context 'and a file higher than the maximum is stored' do
+        before { validatable.image.store! File.open(@test_image_directory + '3-byte-file.txt') }
+
+        it 'is false' do
+          validatable.should_not be_valid
+        end
+      end
+
+      context 'and a file the same as the maximum is stored' do
+        before { validatable.image.store! File.open(@test_image_directory + '2-byte-file.txt') }
+
+        it 'is true' do
+          validatable.should be_valid
+        end
+      end
+    end
+
+    context 'when a `within` range is set' do
+      let(:validatable) { ValidatableClassWithWithin.new }
+
+      context 'and a file below the bottom of the range is stored' do
+        before { validatable.image.store! File.open(@test_image_directory + '0-byte-file.txt') }
+
+        it 'is false' do
+          validatable.should_not be_valid
+        end
+      end
+
+      context 'and a file at the bottom of the range is stored' do
+        before { validatable.image.store! File.open(@test_image_directory + '2-byte-file.txt') }
+
+        it 'is true' do
+          validatable.should be_valid
+        end
+      end
+
+      context 'and a file at the top of the range is stored' do
+        before { validatable.image.store! File.open(@test_image_directory + '4-byte-file.txt') }
+
+        it 'is true' do
+          validatable.should be_valid
+        end
+      end
+
+      context 'and a file above the top of the range is stored' do
+        before { validatable.image.store! File.open(@test_image_directory + '5-byte-file.txt') }
+
+        it 'is false' do
+          validatable.should_not be_valid
+        end
+      end
+    end
+
+    context 'when `is` is set' do
+      let(:validatable) { ValidatableClassWithIs.new }
+
+      context 'and a file below the bottom of the range is stored' do
+        before { validatable.image.store! File.open(@test_image_directory + '0-byte-file.txt') }
+
+        it 'is false' do
+          validatable.should_not be_valid
+        end
+      end
+
+      context 'and a file that is the exact size is stored' do
+        before { validatable.image.store! File.open(@test_image_directory + '2-byte-file.txt') }
+
+        it 'is true' do
+          validatable.should be_valid
+        end
+      end
+
+      context 'and a file above the top of the range is stored' do
+        before { validatable.image.store! File.open(@test_image_directory + '3-byte-file.txt') }
+
+        it 'is false' do
+          validatable.should_not be_valid
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/2-byte-file.txt

@@ -0,0 +1 @@
+a

data/spec/fixtures/3-byte-file.txt

@@ -0,0 +1 @@
+aa

data/spec/fixtures/4-byte-file.txt

@@ -0,0 +1 @@
+aaa

data/spec/fixtures/5-byte-file.txt

@@ -0,0 +1 @@
+aaaa

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'active_model'
+require 'action_view'
+require 'carrierwave'
+require 'oscillator'
+
+Dir[File.expand_path('../support/**/*.rb',   __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.after(:suite) do
+    `rm -rf ./my_model`
+  end
+end

data/spec/support/carrier_wave.rb

@@ -0,0 +1,14 @@
+###
+# Makes CarrierWave tests faster and more reliable
+#
+
+CarrierWave.configure do |config|
+  config.storage           = :file
+  config.enable_processing = false
+end
+
+RSpec.configure do |config|
+  config.before(:each, :carrier_wave => true) do
+    @test_image_directory = File.dirname(__FILE__) + '/../fixtures/'
+  end
+end

data/spec/support/focused.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+  # Configure RSpec to run focused specs, and also respect the alias 'fit' for focused specs
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run       :focused => true
+  config.alias_example_to :fit, :focused => true
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/pending.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  # Configure RSpec to respect the alias 'pit' for pending specs
+  config.alias_example_to :pit, :pending => true
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oscillator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,24 +10,152 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2012-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: carrierwave
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0.5'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: ''
 email: support@chirrpy.com
 executables: []
@@ -36,13 +164,26 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- lib/oscillator/canonical_uploader_path.rb
+- lib/oscillator/file_location_resolver.rb
 - lib/oscillator/file_size_validator.rb
+- lib/oscillator/validations.rb
 - lib/oscillator/version.rb
 - lib/oscillator.rb
 - Rakefile
 - README.md
 - LICENSE
+- spec/file_location_resolver_spec.rb
+- spec/file_size_validator_spec.rb
+- spec/fixtures/0-byte-file.txt
+- spec/fixtures/2-byte-file.txt
+- spec/fixtures/3-byte-file.txt
+- spec/fixtures/4-byte-file.txt
+- spec/fixtures/5-byte-file.txt
+- spec/fixtures/SMALL-LOGO-SHORT-AND-WIDE.PNG
+- spec/spec_helper.rb
+- spec/support/carrier_wave.rb
+- spec/support/focused.rb
+- spec/support/pending.rb
 homepage: https://github.com/chirrpy/oscillator
 licenses: []
 post_install_message: 
@@ -68,4 +209,16 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Shared CarrierWave and Validations and Configurations
-test_files: []
+test_files:
+- spec/file_location_resolver_spec.rb
+- spec/file_size_validator_spec.rb
+- spec/fixtures/0-byte-file.txt
+- spec/fixtures/2-byte-file.txt
+- spec/fixtures/3-byte-file.txt
+- spec/fixtures/4-byte-file.txt
+- spec/fixtures/5-byte-file.txt
+- spec/fixtures/SMALL-LOGO-SHORT-AND-WIDE.PNG
+- spec/spec_helper.rb
+- spec/support/carrier_wave.rb
+- spec/support/focused.rb
+- spec/support/pending.rb

data/lib/oscillator/canonical_uploader_path.rb

@@ -1,9 +0,0 @@
-module CanonicalUploaderPath
-  def filename
-    "#{mounted_as}.#{file.extension.downcase}" if @filename
-  end
-
-  def store_dir
-    "#{model.class.name.underscore}/#{model.id}"
-  end
-end