athergin 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 athergin.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sarkis Karayan
+
+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,30 @@
+# Athergin
+
+Athergin Web Framework
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'athergin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install athergin
+
+## 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 @@
+require 'bundler/gem_tasks'

data/athergin.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'athergin/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'athergin'
+  gem.version       = Athergin::VERSION
+  gem.authors       = ['Sarkis Karayan']
+  gem.email         = ['skarayan@gmail.com']
+  gem.description   = 'Athergin Web Framework'
+  gem.summary       = 'Athergin Web Framework'
+  gem.homepage      = 'https://github.com/skarayan/athergin'
+
+  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.require_paths = ['lib']
+
+  gem.add_dependency 'core_extensions'
+end

data/lib/athergin.rb

@@ -0,0 +1,10 @@
+require 'athergin/version'
+require 'athergin/attribute'
+require 'athergin/platform'
+require 'athergin/namespace'
+require 'athergin/report'
+require 'athergin/query'
+require 'athergin/transformer'
+
+module Athergin
+end

data/lib/athergin/attribute.rb

@@ -0,0 +1,10 @@
+module Attribute
+  def attribute(*names)
+    names.each do |name|
+      instance_variable_name = :"@#{ name }"
+      define_method name do |value=nil|
+        value ? instance_variable_set(instance_variable_name,value) : instance_variable_get(instance_variable_name)
+      end
+    end
+  end
+end

data/lib/athergin/namespace.rb

@@ -0,0 +1,69 @@
+class Namespace
+  extend Attribute
+  attr_reader :reports, :transformers, :display_order
+  attribute :name, :description, :explanation
+
+  def to_h
+    methods = [:name, :description, :current?, :css_class_name, :report_objects]
+    methods.map do |method|
+      key, value = method.to_s.gsub(/\?$/,'').to_sym, send(method)
+      value = '' if value.nil?
+      value = value.to_data if value.is_a? Array
+
+      [key, value]
+    end.to_h
+  end
+
+  class << self
+    def all
+      Platform.namespaces.values rescue []
+    end
+
+    def displayable
+      all.select { |n| n.report_objects.present? }.sort { |a,b| a.display_order <=> b.display_order }
+    end
+
+    def find_by_name(name)
+      all.find { |namespace| namespace.name == name.try(:to_sym) }
+    end
+  end
+
+  def initialize(name, display_order)
+    @name, @display_order = name, display_order
+    @reports = {}
+    @transformers = {}
+  end
+
+  # todo: change this to reports
+  def report_objects
+    reports.values
+  end
+
+  # todo: change this to transformers
+  def transformer_objects
+    transformers.values
+  end
+
+  def report(name, &block)
+    warn "warning: overriding report '#{ name }'" if @reports[name]
+
+    @reports[name] = Report.new name, namespace: self
+    @reports[name].instance_eval &block
+  end
+
+  def transformer(name, &block)
+    warn "warning: overriding transformer '#{ name }'" if @transformers[name]
+
+    @transformers[name] = Transformer.new name
+    @transformers[name].instance_eval &block
+  end
+
+  def current?
+    name.eql? Platform.current_namespace.name
+  end
+
+  # todo: think this over, models are probably not a good place for the css class name
+  def css_class_name
+    current? ? 'active' : 'inactive'
+  end
+end

data/lib/athergin/platform.rb

@@ -0,0 +1,108 @@
+# todo: module Athergin
+module Platform
+  class << self
+    attr_reader :config, :connections, :namespaces, :eval_queue
+
+    def load_config!(config_file='config/environment.yml')
+      @config = Configuration.new config_file
+    end
+
+    def connect!
+      @connections = {}
+      config.environments.each do |env|
+        database = config.database_config env
+        begin
+          pool_size, pool_timeout = database.pool_size || 50, database.pool_timeout || 60
+          if database.hosts.present?
+            @connections[env] = Mongo::ReplSetConnection.new database.hosts, pool_size: pool_size, pool_timeout: pool_timeout
+          else
+            @connections[env] = Mongo::Connection.new database.hostname, database.port, pool_size: pool_size, pool_timeout: pool_timeout
+          end
+        rescue Mongo::ConnectionFailure => e
+          warn "Warning (could not connect to the #{ env } environment, skipping): #{ e.message }"
+        end
+      end
+    end
+
+    def namespace(name, opts={}, &block)
+      file_execution_order = namespace_display_order = opts[:display_order] || 10_000
+
+      @namespaces = {} if @namespaces.nil?
+      @namespaces[name] = Namespace.new(name, namespace_display_order) if @namespaces[name].nil?
+
+      @eval_queue = [] if @eval_queue.nil?
+      @eval_queue << [file_execution_order, @namespaces[name], block]
+    end
+
+    # execute the files in the right order as specified in the reports directory (for display order in index page and menu)
+    def run_eval_queue!
+      eval_queue.sort { |a,b| a.first <=> b.first }.each do |file_execution_order,namespace,block|
+        namespace.instance_eval &block
+      end
+    end
+
+    def params
+      Thread.current[:params]
+    end
+
+    def search_params
+      (params[:search] || {}).reject { |param,value| value.blank? }
+    end
+
+    def exact_match?
+      params[:exact_match].present?
+    end
+
+    def query_limit
+      params[:limit]
+    end
+
+    def query_offset
+      params[:offset]
+    end
+
+    def cookies
+      Thread.current[:cookies] || {}
+    end
+
+    def environment
+      @environment || cookies['environment'].try(:to_sym) || ENV['REPORTS_ENV'].try(:to_sym) || :development
+    end
+
+    def set_environment!(env)
+      puts "Setting environment as #{ env }"
+      @environment = env.to_sym
+    end
+
+    def connected_environments
+      # todo: reverse is kind of ugly here
+      @connections.keys.reverse rescue []
+    end
+
+    def connection
+      @connections[environment]
+    end
+
+    def database_name(name)
+      database_name = Platform.config.database_override.try(name) || name
+    end
+
+    def database(name)
+      Platform.connection[database_name(name)]
+    end
+
+    def current_namespace
+      current_report.try(:namespace)
+    end
+
+    def current_report
+      return unless params[:type].eql? 'reports'
+      Report.find_by_name params[:name]
+    end
+
+    def current_query
+      return unless params[:type].eql? 'queries'
+      Query.find_by_name params[:name]
+    end
+  end
+end

data/lib/athergin/query.rb

@@ -0,0 +1,189 @@
+class Query
+  extend Attribute
+  attribute :name, :description, :explanation, :database, :filters, :fields, :field_groups, :search_mapping
+  attr_accessor :partial_search_fields # todo: clean this up
+  attr_accessor :results_block, :query_block, :transform_block, :callback_blocks # todo: rename all these *_block attributes to remove the '_block' from the name
+
+  class << self
+    # todo: change this to queries
+    def all
+      Report.all.map(&:query_objects).flatten
+    end
+
+    def find_by_name(name)
+      all.find { |query| query.name == name.try(:to_sym) }
+    end
+  end
+
+  def initialize(name)
+    @name = name
+    @fields = {}
+    @search_mapping = {}
+    @partial_search_fields = []
+    @default_sort_fields = {}
+    @filters = {}
+    @show_all_on_load = false
+    @transform_block = Proc.new { raise 'Please implement the transform block in your query.' }
+    @results_block = Proc.new { query.to_a.map { |row| self.instance_exec row, &transform_block } }
+    @callback_blocks = {}
+  end
+
+  def collection(name=nil)
+    if name
+      if name.is_a? Symbol
+        @collection = name
+      elsif name.is_a? String
+        db,tbl = name.split('/').map(&:to_sym)
+        database db
+        collection tbl
+      end
+    else
+      @collection
+    end
+  end
+
+  # todo: change naming of this method to make it more consistent
+  def allow_partial_search_for(*fields)
+    @partial_search_fields = fields.map(&:to_sym)
+  end
+
+  # todo: refactor to use attribute for consistency
+  def limit_results_to(count)
+    @limit = count
+  end
+
+  def params
+    Platform.search_params
+  end
+
+  def limit
+    Platform.query_limit || @limit || 1000
+  end
+
+  def offset
+    Platform.query_offset || @offset || 0
+  end
+
+  def exact_match
+    Platform.exact_match? || @exact_match || false
+  end
+
+  def partial_match
+    !exact_match
+  end
+
+  # todo: remove to_sym (everywhere in code), use hash_with_indifferent_attributes
+  def allow_partial_match?(field=nil)
+    if field.present?
+      partial_match && partial_search_fields.include?(field.to_sym)
+    else
+      @partial_search_fields.present?
+    end
+  end
+
+  def where
+    params.map do |field,value|
+      field = search_mapping[field.to_sym]
+      next if field.nil?
+
+      value = /#{ value }/i if allow_partial_match? field
+      [field,value]
+    end.compact.to_h.merge @filters
+  end
+
+  # todo: refactor @filters and @default_sort_fields to method calls
+  def query
+    return self.instance_eval(&query_block) if query_block
+
+    # todo: add namespace and report name in error message
+    raise "No collection specified for '#{ name }'" if collection.nil?
+    raise "No database specified for '#{ name }'" if database.nil?
+
+    puts "find: #{ Platform.database_name(database.to_s) }/#{ collection } -> #{ where.inspect }"
+    Platform.database(database.to_s)[collection.to_s].find(where).sort(@default_sort_fields).limit(limit).skip(offset)
+  end
+
+  def define_query(&block)
+    @query_block = block
+  end
+
+  def results(&block)
+    @results_block = block
+  end
+
+  def transform(&block)
+    @transform_block = block
+  end
+
+  def data
+    self.instance_eval &results_block
+  end
+
+  # todo: rename for consistensy
+  def default_sort_by(sort_fields)
+    @default_sort_fields = sort_fields
+  end
+
+  # todo: review since it is redundant in both Report and Query
+  def show_all_on_load
+    @show_all_on_load = true
+  end
+
+  def require_search?
+    !show_all_on_load?
+  end
+
+  def show_all_on_load?
+    @show_all_on_load
+  end
+
+  def view_name
+    :query
+  end
+
+  def listen_for(callback,&block)
+    @callback_blocks[callback] = block
+  end
+
+# todo: cleanup
+=begin
+  def to_tsv
+    results.unshift(self.class.fields).map { |row| row.join("\t") }.join("\n")
+  end
+
+  def save(filename)
+    File.open(filename, 'w') { |f| f.write to_tsv }
+  end
+
+  class << self
+    def from(collection_name)
+      db,tbl = collection_name.split('/')
+      define_singleton_method(:from_database) { db }
+      define_singleton_method(:from_collection) { tbl }
+    end
+
+    def group_by(field_name)
+      define_singleton_method(:group_by_field) { field_name }
+    end
+
+    def aggregate(fields)
+      define_singleton_method(:aggregate_fields) { fields }
+    end
+
+    def javascript_aggregate_map_function
+      erb = File.read('mapreduce/aggregate_map.js.erb')
+      Erubis::Eruby.new(erb).result group_by: group_by_field, aggregate: aggregate_fields
+    end
+
+    def javascript_aggregate_reduce_function
+      erb = File.read('mapreduce/aggregate_reduce.js.erb')
+      Erubis::Eruby.new(erb).result aggregate: aggregate_fields
+    end
+
+    def run
+      m, r = javascript_aggregate_map_function, javascript_aggregate_reduce_function
+      Platform.database(from_database)[from_collection].map_reduce m, r, out: { replace: collection, db: database }
+    end
+  end
+=end
+end

data/lib/athergin/report.rb

@@ -0,0 +1,79 @@
+class Report
+  extend Attribute
+  attr_reader :queries, :namespace
+  attribute :name, :description, :explanation, :search_fields
+
+  def to_h
+    methods = [:name, :description, :url, :current?, :css_class_name]
+    methods.map do |method|
+      key, value = method.to_s.gsub(/\?$/,'').to_sym, send(method)
+      value = '' if value.nil?
+      value = value.to_data if value.is_a? Array
+
+      [key, value]
+    end.to_h
+  end
+
+  class << self
+    # todo: change this to reports
+    def all
+      Namespace.all.map(&:report_objects).flatten
+    end
+
+    def find_by_name(name)
+      all.find { |report| report.name == name.try(:to_sym) }
+    end
+  end
+
+  def initialize(name,opts={})
+    @name = name
+    @namespace = opts[:namespace]
+    @queries = {}
+    @show_all_on_load = false
+  end
+
+  # todo: change this to queries
+  def query_objects
+    queries.values
+  end
+
+  def url
+    "/reports/#{ name }"
+  end
+
+  def query(name, &block)
+    warn "warning: overriding query '#{ name }'" if @queries[name]
+
+    @queries[name] = Query.new name
+    @queries[name].instance_eval &block
+  end
+
+  def show_all_on_load
+    @show_all_on_load = true
+  end
+
+  def require_search?
+    !show_all_on_load?
+  end
+
+  def show_all_on_load?
+    @show_all_on_load
+  end
+
+  def allow_partial_match?
+    query_objects.select { |query| query.allow_partial_match? }.present?
+  end
+
+  def view_name
+    :report
+  end
+
+  def current?
+    name.eql? Platform.current_report.name
+  end
+
+  # todo: think this over, models are probably not a good place for the css class name
+  def css_class_name
+    current? ? 'active' : 'inactive'
+  end
+end

data/lib/athergin/transformer.rb

@@ -0,0 +1,61 @@
+class Transformer
+  extend Attribute
+  attr_reader :maps
+  attribute :defaults, :reduce, :database
+
+  def initialize(name)
+    @maps, @reduce = [], []
+  end
+
+  def collection(name=nil)
+    if name
+      if name.is_a? Symbol
+        @collection = name
+      elsif name.is_a? String
+        db,tbl = name.split('/').map(&:to_sym)
+        database db
+        collection tbl
+      end
+    else
+      @collection
+    end
+  end
+
+  def map(hash)
+    raise 'Please specify collection for Transformer map' if hash[:collection].nil?
+    raise 'Please specify values for Transformer map' if hash[:values].nil?
+    @maps.push hash
+  end
+
+  def sum(field)
+    "+= value.#{ field } ? value.#{ field } : 0"
+  end
+
+  def mongodb_map_functions
+    erb = File.read('mapreduce/mongodb_map.js.erb')
+    maps.map do |map|
+      database, collection = map[:collection].split('/')
+      function = Erubis::Eruby.new(erb).result keys: map[:keys], values: map[:values]
+      [database,collection,function]
+    end
+  end
+
+  def mongodb_reduce_function
+    erb = File.read('mapreduce/mongodb_reduce.js.erb')
+    Erubis::Eruby.new(erb).result defaults: defaults, fields: reduce
+  end
+
+  def run_mapreduce
+    puts "Dropping collection #{ Platform.database_name(database) }/#{ collection }"
+    Platform.database(database.to_s)[collection.to_s].drop
+
+    mongodb_map_functions.each do |map_database,map_collection,mongodb_map_function|
+      puts "Loading #{ Platform.database_name(database.to_s) }/#{ collection } from #{ Platform.database_name(map_database) }/#{ map_collection }"
+      Platform.database(map_database)[map_collection].map_reduce mongodb_map_function,
+                                                                 mongodb_reduce_function,
+                                                                 out: { reduce: collection.to_s, db: Platform.database_name(database.to_s) }
+    end
+
+    true
+  end
+end

data/lib/athergin/version.rb

@@ -0,0 +1,3 @@
+module Athergin
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: athergin
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.1
+platform: ruby
+authors:
+- Sarkis Karayan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-09-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: core_extensions
+  version_requirements: &2056 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: *2056
+  prerelease: false
+  type: :runtime
+description: Athergin Web Framework
+email:
+- skarayan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- athergin.gemspec
+- lib/athergin.rb
+- lib/athergin/attribute.rb
+- lib/athergin/namespace.rb
+- lib/athergin/platform.rb
+- lib/athergin/query.rb
+- lib/athergin/report.rb
+- lib/athergin/transformer.rb
+- lib/athergin/version.rb
+homepage: https://github.com/skarayan/athergin
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.15
+signing_key:
+specification_version: 3
+summary: Athergin Web Framework
+test_files: []
+...