devlin 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,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in devlin.gemspec
+gemspec
+gem 'rspec'
+gem 'sqlite3'
+gem 'pry'
+gem 'factory_girl'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Paul Spieker
+
+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,80 @@
+# Devlin
+
+Devlin gives users the ability to define reporting database queries. 
+The queries are defined in yaml and using predefined scopes. Since 
+the sql statements are defined by the developer, the user is not able 
+to corrupt the database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'devlin', :git => 'https://github.com/spieker/devlin.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+First you have to setup Devlin and define base scopes which can be used
+to define queries. In Rails you can do this in an initializer.
+
+    # config/initializers/devlin.rb
+   
+    class ReportBuilder < Devlin::Base 
+      scope :transaction do |params|
+        relation Transaction.where(user_id: params[:user_id]).scoped
+        
+        column :manufacturer, "manufacturer"
+        column :year, "YEAR(date)"
+        column :month, "MONTH(date)" do |value|
+          months = %W(~ Jan Feb Mar Apr May Jun Jul Aug Sep Okt Nov Dec)
+          months[value]
+        end
+        column :earnings, "SUM(costs*IF(direction='in', -1, 1))"
+      end
+
+      # more scopes ...
+    end
+
+Now you can define queries on the configured scopes
+
+    # app/controllers/report_controller.rb
+
+    ...
+    def report
+      @relation = Devlin.new(user_id: current_user.id).query(params[:q]).result
+    end
+    ...
+
+The parameter "q" has to contain the query defined in yaml. The query
+can look like this:
+
+    scope: transaction
+    select:
+      - manufacturer
+      - month
+      - earnings
+    conditions:
+      year: 2012
+    group:
+      - manufacturer
+      - month
+
+The generated query returns a sum of earnings for each manufacturer and
+each month in the year 2012.
+
+## Todo
+
+* Params for columns to have i.e. one column for each month and a list
+  of manufacturers
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/devlin.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/devlin/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paul Spieker"]
+  gem.email         = ["p.spieker@duenos.de"]
+  gem.description   = %q{Devlin gives users the ability to define reporting database queries}
+  gem.summary       = %q{Devlin gives users the ability to define reporting database queries. The queries are defined in yaml and using predefined scopes. Since the sql statements are defined by the developer, the user is not able to corrupt the database.}
+  gem.homepage      = "https://github.com/spieker/devlin"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "devlin"
+  gem.require_paths = ["lib"]
+  gem.version       = Devlin::VERSION
+
+  gem.add_dependency 'activerecord', '>= 3.0.0'
+  gem.add_dependency 'activesupport', '>= 3.0.0'
+end

data/lib/devlin/base.rb

@@ -0,0 +1,32 @@
+module Devlin
+  class Base
+    def initialize(params)
+      @params = params
+    end
+
+    # returns the keys of the defined scopes
+    def self.scopes
+      @scopes.keys
+    end
+
+    def self.[](name)
+      @scopes[name.to_sym]
+    end
+
+    def scope(name)
+      @scope ||= {}
+      @scope[name.to_sym] ||= Scope.new(@params, &(self.class[name.to_sym]))
+      @scope[name.to_sym]
+    end
+
+    def query(q)
+      Query.new(self, q)
+    end
+
+    private
+    def self.scope(name, &block)
+      @scopes ||= {}
+      @scopes[name.to_sym] = block
+    end
+  end
+end

data/lib/devlin/column.rb

@@ -0,0 +1,24 @@
+module Devlin
+  class Column
+    def initialize(name, config)
+      @name = name
+      @config = config
+    end
+
+    def select_definition
+      "#{@config[:definition]} AS #{@name}"
+    end
+
+    def definition
+      @config[:definition]
+    end
+
+    def value(value)
+      if @config[:getter].respond_to?(:call)
+        @config[:getter].call(value)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/devlin/query.rb

@@ -0,0 +1,26 @@
+module Devlin
+  class Query
+    attr_reader :query, :scope, :select, :conditions, :group
+
+    def initialize(parent, q)
+      @parent = parent
+      @query = YAML.load(q)
+      @scope = parent.scope(query['scope'])
+      @select = query['select']
+      @conditions = query['conditions']
+      @group = query['group']
+    end
+
+    # This method returns the resulting relation to calculate the given
+    # query
+    def result
+      res = @scope.relation
+      res = res.select(self.select.map { |c| @scope.column(c).select_definition })
+      @conditions.each do |col, val|
+        res = res.where(["#{@scope.column(col).definition}=?", val.to_s])
+      end
+      res = res.group(self.group.map { |c| @scope.column(c).definition })
+      res
+    end
+  end
+end

data/lib/devlin/scope.rb

@@ -0,0 +1,50 @@
+module Devlin
+  class Scope
+    # The configuration object simplifies the configuration of the scope
+    class Config
+      attr_reader :params
+
+      def initialize(scope, params, &block)
+        @scope = scope
+        @params = params
+        instance_eval(&block)
+      end
+
+      def relation(rel)
+        @scope.relation = rel  
+      end
+
+      def column(name, definition, &block)
+        @scope.add_column(name, definition, &block)
+      end
+    end
+
+    attr_accessor :relation
+
+    def initialize(params, &block)
+      Config.new(self, params, &block)
+    end
+
+    # add a column definition to the scope
+    def add_column(name, definition, &block)
+      @columns ||= {}
+      @columns[name.to_sym] = Column.new name, {
+        definition: definition,
+        getter: block
+      }
+    end
+
+    def columns
+      @columns ||= {}
+      @columns.keys
+    end
+
+    def column(name)
+      @columns ||= {}
+      column = @columns[name.to_sym]
+      raise "no column '#{name}' found" if column.blank?
+      column
+    end
+    
+  end
+end

data/lib/devlin/version.rb

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

data/lib/devlin.rb

@@ -0,0 +1,12 @@
+require "devlin/version"
+require 'active_record'
+require 'active_support'
+require "devlin/base"
+require "devlin/scope"
+require "devlin/column"
+require "devlin/query"
+require 'yaml'
+
+module Devlin
+  # Your code goes here...
+end

data/spec/factories.rb

@@ -0,0 +1,10 @@
+require 'factory_girl'
+
+FactoryGirl.define do
+  factory :transaction do
+    user_id 1
+    manufacturer 'M1'
+    date Date.parse('2012-08-18')
+    costs 100
+  end
+end

data/spec/query_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe TestReport do
+  before :each do
+    100.times do |i|
+      FactoryGirl.create :transaction, date: Date.parse('2012-08-18')+i.days
+      FactoryGirl.create :transaction, date: Date.parse('2012-08-18')+i.days, manufacturer: 'M2'
+    end
+    @q = <<-EOF
+      scope: transaction
+      select:
+        - month
+        - manufacturer
+        - earnings
+      conditions:
+        year: 2012
+      group:
+        - manufacturer
+        - month
+    EOF
+  end
+
+  describe 'query' do
+    it 'should contain the given query' do
+      rep = TestReport.new user_id: 1
+      rep.query(@q).scope.should eq(rep.scope(:transaction))
+      rep.query(@q).select.should eq(['month', 'manufacturer', 'earnings'])
+      rep.query(@q).conditions.should eq('year' => 2012)
+      rep.query(@q).group.should eq(['manufacturer', 'month'])
+    end
+
+    describe 'result' do
+      it 'should only contain the selected columns' do
+        rep = TestReport.new user_id: 1
+        rep.query(@q).result.first.attributes.keys.map(&:to_sym).should eq([:month, :manufacturer, :earnings])
+      end
+    end
+  end
+end

data/spec/setup_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe TestReport do
+  it 'should contain all configured scopes' do
+    TestReport.scopes.should eq([:transaction])
+  end
+
+  describe 'transaction scope' do
+    it 'should have a relation' do
+      rep = TestReport.new(user_id: 1)
+      scope = rep.scope(:transaction)
+      scope.relation.class.should eq(ActiveRecord::Relation)
+    end
+
+    it 'should have all configured columns' do
+      rep = TestReport.new(user_id: 1)
+      scope = rep.scope(:transaction)
+      scope.columns.should eq([:manufacturer, :year, :month, :earnings])
+    end
+
+    describe 'column' do
+      it 'should return the column definition including "AS"' do
+        rep = TestReport.new(user_id: 1)
+        scope = rep.scope(:transaction)
+        scope.column(:manufacturer).select_definition.should eq('manufacturer AS manufacturer')
+        scope.column(:year).select_definition.should eq("strftime('%Y', date) AS year")
+      end
+
+      it 'should return the column value as is, if no getter is defined' do
+        rep = TestReport.new(user_id: 1)
+        scope = rep.scope(:transaction)
+        scope.column(:manufacturer).value('hallo welt').should eq('hallo welt')
+      end
+
+      it 'should return the value calculated by the getter method if defined' do
+        rep = TestReport.new(user_id: 1)
+        scope = rep.scope(:transaction)
+        scope.column(:month).value(2).should eq('Feb')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'devlin'
+require 'sqlite3'
+require 'pry'
+require 'factory_girl'
+
+root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.before :each do
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.begin_db_transaction
+  end
+  config.after :each do
+    ActiveRecord::Base.connection.rollback_db_transaction
+    ActiveRecord::Base.connection.decrement_open_transactions
+  end
+end
+
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: "#{root}/spec/test.sqlite3"
+)
+
+class TestReport < Devlin::Base
+  scope :transaction do |scope|
+    relation Transaction.where(user_id: scope.params[:user_id]).scoped
+    
+    column :manufacturer, "manufacturer"
+    column :year, "strftime('%Y', date)"
+    column :month, "strftime('%m', date)" do |value|
+      months = %W(~ Jan Feb Mar Apr May Jun Jul Aug Sep Okt Nov Dec)
+      months[value]
+    end
+    column :earnings, "SUM(costs)"
+  end
+end
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'transactions'")
+ActiveRecord::Base.connection.create_table(:transactions) do |t|
+  t.integer   :user_id
+  t.string    :manufacturer
+  t.datetime  :date
+  t.float     :costs
+end
+class Transaction < ActiveRecord::Base
+end
+
+FactoryGirl.find_definitions

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: devlin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Spieker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Devlin gives users the ability to define reporting database queries
+email:
+- p.spieker@duenos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- devlin.gemspec
+- lib/devlin.rb
+- lib/devlin/base.rb
+- lib/devlin/column.rb
+- lib/devlin/query.rb
+- lib/devlin/scope.rb
+- lib/devlin/version.rb
+- spec/factories.rb
+- spec/query_spec.rb
+- spec/setup_spec.rb
+- spec/spec_helper.rb
+- spec/test.sqlite3
+homepage: https://github.com/spieker/devlin
+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.8.24
+signing_key: 
+specification_version: 3
+summary: Devlin gives users the ability to define reporting database queries. The
+  queries are defined in yaml and using predefined scopes. Since the sql statements
+  are defined by the developer, the user is not able to corrupt the database.
+test_files:
+- spec/factories.rb
+- spec/query_spec.rb
+- spec/setup_spec.rb
+- spec/spec_helper.rb
+- spec/test.sqlite3
+has_rdoc: