melitta 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,28 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  # with Minitest::Unit
+  #watch(%r{^test/(.*)\/?test_(.*)\.rb})
+  #watch(%r{^lib/(.*/)?([^/]+)\.rb})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  #watch(%r{^test/test_helper\.rb})      { 'test' }
+
+  # with Minitest::Spec
+  watch(%r{^spec/(.*)_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb})
+  # watch(%r{^test/test_helper\.rb}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Dietz
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Melitta
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'melitta'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install melitta
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/melitta'
+  t.test_files = FileList['spec/lib/melitta/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/melitta.rb

@@ -0,0 +1,15 @@
+require 'active_support/core_ext/object/blank'
+require 'melitta/version'
+require 'melitta/filter_dsl'
+require 'melitta/bridges'
+require 'melitta/filters'
+require 'melitta/coercers'
+
+module Melitta
+
+  def self.filter
+    Bridges::Base
+  end
+
+end
+

data/lib/melitta/bridges.rb

@@ -0,0 +1 @@
+require_relative './bridges/base'

data/lib/melitta/bridges/base.rb

@@ -0,0 +1,24 @@
+module Melitta::Bridges
+
+  module Base
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+
+      def filter field, &block
+        filter = Melitta::FilterDsl.evaluate(Melitta::Filters::Tree, &block)
+        class_variable_set("@@#{field}_filter", filter)
+
+        define_method :"#{field}_filter" do |params|
+          filter.run(params.fetch(field, {}))
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/melitta/coercers.rb

@@ -0,0 +1,168 @@
+module Melitta::Coercers
+
+  def self.evaluate(coercer)
+    coercer = coercer.is_a?(Class) ? coercer.name : coercer
+    "Melitta::Coercers::#{coercer}".constantize
+  end
+
+  Identity = Struct.new(:input) do
+
+    def valid?
+      true
+    end
+
+    def output
+      input
+    end
+
+  end
+
+  String = Struct.new(:input) do
+
+    def valid?
+      true
+    end
+
+    def output
+      input.to_s
+    end
+
+  end
+
+  Integer = Struct.new(:input) do
+
+    def valid?
+      !! /\A\d*\z/.match(input)
+    end
+
+    def output
+      input.to_i
+    end
+
+  end
+
+  Float = Struct.new(:input) do
+
+    def valid?
+      !! /\A\d+([,.]\d+)?\z/.match(input)
+    end
+
+    def output
+      output = input
+      output = input.gsub(',', '.') if /(\d)*,(\d)*/.match(input)
+      output.to_f
+    end
+
+  end
+
+  Boolean = Struct.new(:input) do
+
+    def valid?
+      input.blank? || input =~ (/\A(true|1|false|0)\z/i)
+    end
+
+    def output
+      (input =~ (/(true|1)$/i)) === 0
+    end
+
+  end
+
+  Date = Struct.new(:input) do
+
+    def valid?
+      # valid formats are
+      # day[.-/]month[.-/]year or year[.-/]month[.-/]day
+      # year has to be 4 digits, due to Date.parse misinterpreting ambiguous values, e.g. "26.02.13" as Feb 13th 2026
+      # month [01-12] and day [01-31] can be single or double digits
+      if !! /\A((?:\d{4}[-.\/](0?[1-9]|1[012])[-.\/](0?[1-9]|[12][0-9]|3[01]))|(?:(0?[1-9]|[12][0-9]|3[01])[-.\/](0?[1-9]|1[012])[-.\/]\d{4}))\z/.match(input)
+        begin
+          ::Date.parse(input)
+        rescue ArgumentError
+          return false
+        end
+        return true
+      else
+        return false
+      end
+    end
+
+    def output
+      ::Date.parse(input)
+    end
+
+  end
+
+  MonthYear = Struct.new(:input) do
+    # valid formats are
+    # month[.-/]year or year[.-/]month
+    # year has to be 4 digits to force unambiguity
+    def valid?
+      !! /\A((?:\d{4}[-.\/](0?[1-9]|1[012]))|(?:(0?[1-9]|1[012])[-.\/]\d{4}))\z/.match(input)
+    end
+
+    def output
+      month = input.scan(/\b(?:0?[1-9]|1[012])\b/)[0].to_i
+      year  = input.scan(/\b\d{4}\b/)[0].to_i
+
+      ::Date.new(year, month)
+    end
+
+  end
+
+  Tree = Struct.new(:input) do
+
+    def origin
+      input.each_with_object({}) do |(k,v), hsh|
+        hsh[k] = v.respond_to?(:origin) ? v.origin : v.input
+      end
+    end
+
+    def errors
+      input.each_with_object({}) do |(k,v), hsh|
+        unless v.valid?
+          hsh[k] = v.respond_to?(:errors) ? v.errors : I18n.t("errors.coercers.#{v.class.name.demodulize.downcase}")
+        end
+      end
+    end
+
+    def valid?
+      input.all? { |k,v| v.valid? }
+    end
+
+    def output
+      input.each_with_object({}) do |(k,v), hsh|
+        hsh[k] = v.output
+      end
+    end
+
+  end
+
+  MissingInput = Struct.new(:input) do
+
+    def errors
+      I18n.t("errors.coercers.missing_input")
+    end
+
+    def valid?
+      false
+    end
+
+    def output
+      input
+    end
+
+  end
+
+  OptionalInput = Struct.new(:input) do
+
+    def valid?
+      true
+    end
+
+    def output
+      input
+    end
+
+  end
+
+end

data/lib/melitta/filter_dsl.rb

@@ -0,0 +1,61 @@
+class Melitta::FilterDsl
+
+  attr_reader :receiver
+
+  def self.evaluate type, &block
+    filter = new(type)
+    filter.instance_eval &block
+    filter.receiver
+  end
+
+  def initialize(receiver)
+    @receiver = receiver.new
+  end
+
+  def keep field, coercer = String, &block
+    if block_given?
+      filter = evaluate(Melitta::Filters::Tree, block)
+    else
+      filter = Melitta::Filters::Base.new()
+      filter.coercer = evaluate_coercer(coercer)
+    end
+
+    receiver.filter(field, filter)
+  end
+
+  def demand field, coercer = String, &block
+    if block_given?
+      filter = evaluate(Melitta::Filters::Tree, block)
+      filter.required = true
+    else
+      filter = Melitta::Filters::Base.new
+      filter.required = true
+      filter.coercer = evaluate_coercer(coercer)
+    end
+
+    receiver.filter(field, filter)
+  end
+
+  def allow field, &block
+    if block_given?
+      filter = Melitta::Filters::PassThrough.new
+      second_level_filter = evaluate(Melitta::Filters::Tre, block)
+      filter.filter(field, second_level_filter)
+    else
+      filter = Melitta::Filters::PassThrough.new
+    end
+
+    receiver.filter(field, filter)
+  end
+
+protected
+
+  def evaluate filter, block
+    self.class.evaluate(filter, &block)
+  end
+
+  def evaluate_coercer coercer
+    Melitta::Coercers.evaluate(coercer)
+  end
+
+end

data/lib/melitta/filters.rb

@@ -0,0 +1,3 @@
+require_relative './filters/base'
+require_relative './filters/tree'
+require_relative './filters/pass_through'

data/lib/melitta/filters/base.rb

@@ -0,0 +1,25 @@
+module Melitta::Filters
+
+  class Base
+
+    attr_accessor :required, :coercer
+
+    def run(params)
+      if required && params.blank?
+        return ::Melitta::Coercers::MissingInput.new(params)
+      elsif !required && params.blank?
+        return ::Melitta::Coercers::OptionalInput.new(params)
+      else
+        result(params)
+      end
+    end
+
+  protected
+
+    def result(params)
+      coercer.new(params)
+    end
+
+  end
+
+end

data/lib/melitta/filters/pass_through.rb

@@ -0,0 +1,31 @@
+module Melitta::Filters
+
+  class PassThrough < Base
+
+    attr_reader :second_level_filter
+
+    def run(params)
+      if second_level_filter && params.respond_to?(:each)
+        result(params)
+      else
+        params
+      end
+    end
+
+    def filter(field, filter)
+      @second_level_filter = filter
+    end
+
+  protected
+
+    def result(params)
+      result = params.each_with_object({}) do |(key, value), result|
+        result[key] = second_level_filter.run(value)
+      end
+
+      ::Melitta::Coercers::Tree.new(result)
+    end
+
+  end
+
+end

data/lib/melitta/filters/tree.rb

@@ -0,0 +1,27 @@
+module Melitta::Filters
+
+  class Tree < Base
+
+    attr_reader :filters
+
+    def initialize
+      @filters = {}
+    end
+
+    def filter field, filter
+      filters[field] = filter
+    end
+
+  protected
+
+    def result(params)
+      result = filters.each_with_object({}) do |(field, filter), result|
+        result[field] = filter.run(params.fetch(field, ""))
+      end
+
+      ::Melitta::Coercers::Tree.new(result)
+    end
+
+  end
+
+end

data/lib/melitta/version.rb

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

data/melitta.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'melitta/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "melitta"
+  spec.version       = Melitta::VERSION
+  spec.authors       = ["Michael Dietz"]
+  spec.email         = ["michael.dietz@ivoke.de"]
+  spec.description   = "Filter user input without loosing state"
+  spec.summary       = ""
+  spec.homepage      = "https://github.com/ivoke/melitta"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 3.2.0"
+  spec.add_dependency "i18n"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
+end

data/spec/lib/melitta/bridges/base_spec.rb

@@ -0,0 +1,33 @@
+require_relative '../../../spec_helper'
+
+describe Melitta::Bridges::Base do
+
+  describe ".filter" do
+
+    before(:each) do
+      subject.filter :field do; end
+    end
+
+    subject do
+      Class.new { include Melitta.filter }
+    end
+
+    it "sets a filter" do
+      subject
+        .class_variable_get("@@field_filter")
+        .must_be_kind_of(Melitta::Filters::Tree)
+    end
+
+    it "has a filter method defined" do
+      subject.new.must_respond_to(:field_filter)
+    end
+
+    it "returns an optional input coercer" do
+      subject.new
+        .field_filter({})
+        .must_be_kind_of(Melitta::Coercers::OptionalInput)
+    end
+
+  end
+
+end

data/spec/lib/melitta/filters_spec.rb

@@ -0,0 +1,6 @@
+require_relative '../../spec_helper'
+
+describe Melitta::Filters do
+
+
+end

data/spec/lib/melitta/version_spec.rb

@@ -0,0 +1,9 @@
+require_relative '../../spec_helper'
+
+describe Melitta do
+
+  it "must be defined" do
+    Melitta::VERSION.wont_be_nil
+  end
+
+end

data/spec/lib/melitta_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../spec_helper'
+
+describe Melitta do
+
+  describe "Filter Module" do
+    subject { Melitta.filter }
+
+    it "should be a module" do
+      subject.must_be_kind_of(Module)
+    end
+
+  end
+
+  describe "Including a Filter Module" do
+
+    subject { Class.new { include Melitta.filter } }
+
+    it "should have a filter interface defined" do
+      subject.must_respond_to(:filter)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/melitta.rb', __FILE__)

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: melitta
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Dietz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Filter user input without loosing state
+email:
+- michael.dietz@ivoke.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/melitta.rb
+- lib/melitta/bridges.rb
+- lib/melitta/bridges/base.rb
+- lib/melitta/coercers.rb
+- lib/melitta/filter_dsl.rb
+- lib/melitta/filters.rb
+- lib/melitta/filters/base.rb
+- lib/melitta/filters/pass_through.rb
+- lib/melitta/filters/tree.rb
+- lib/melitta/version.rb
+- melitta.gemspec
+- spec/lib/melitta/bridges/base_spec.rb
+- spec/lib/melitta/filters_spec.rb
+- spec/lib/melitta/version_spec.rb
+- spec/lib/melitta_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ivoke/melitta
+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.23
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/lib/melitta/bridges/base_spec.rb
+- spec/lib/melitta/filters_spec.rb
+- spec/lib/melitta/version_spec.rb
+- spec/lib/melitta_spec.rb
+- spec/spec_helper.rb