record_formatter 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb97b5ed84a8255d3837fe50729c938af476c430
+  data.tar.gz: c3720942f9d362e3362ce4b2ee0052bc203e5241
+SHA512:
+  metadata.gz: 1d566a924f854b85a526c8972fddf2aba0d44bd6ff472b1cc8437fa67eed8cc70d1441384e9e06af77074eb2401455ce8d52456ee4e067f7e2c5e9c58f60ad4d
+  data.tar.gz: 64fc9e256e9f64e234b7eba59b0736a6841b3a4ab5d9cd13116c89e17b107bbc037252a74b5e4e7734f678407523687f51358877acafbbe5c9ba78a0b907d930

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.rdoc

@@ -0,0 +1,37 @@
+record_formatter
+===============
+
+RecordFormatter plucks columns from records given a scope, aliased if needed and returns an activerecord relation
+
+Installation
+-----------
+
+    gem install record_formatter
+
+or by including this line in your Gemfile
+
+    gem "record_formatter", :git => "git://github.com/tskorupa/record_formatter.git"
+
+Usage
+-----
+
+    require 'record_formatter'
+
+    Class Foo < ActiveRecord::Base
+      scope :recently_updated, -> { where("updated_at >= ?", 5.days.ago) }
+
+      acts_as_record_formatter scope: :recently_updated do
+        columns :id, :created_at, :updated_at
+        columns :name, alias: :foo_name
+      end
+    end
+
+    irb(main):001:0> Foo.deployable
+      Foo Load (1.0ms)  SELECT "foos".* FROM "foos"  WHERE (updated_at >= '2014-11-29 19:34:08.363155')
+    => #<ActiveRecord::Relation []>
+    irb(main):002:0>
+
+TODO
+================
+
+* allow to set custom name scope

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RecordFormatter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/record_formatter.rb

@@ -0,0 +1,32 @@
+require 'active_support/concern'
+require 'record_formatter/base'
+require 'record_formatter/model'
+require 'record_formatter/column'
+
+module RecordFormatter
+  extend ActiveSupport::Concern
+
+  included do
+  end
+
+  module ClassMethods
+
+    def acts_as_record_formatter options={}, &block
+      @record_formatter ||= RecordFormatter::Base.new(self, options)
+      @record_formatter.instance_eval(&block) if block
+      @record_formatter
+
+      extend RecordFormatter::LocalClassMethods
+    end
+
+  end
+
+  module LocalClassMethods
+    def deployable
+      @record_formatter.deployable_records
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :include, RecordFormatter

data/lib/record_formatter/base.rb

@@ -0,0 +1,43 @@
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/array/extract_options'
+
+module RecordFormatter
+  class Base
+
+    DEFAULT_SCOPE = :all
+    VALID_OPTIONS = %i(scope)
+
+    def initialize klass, options={}
+      @klass = klass
+      @models = {}
+      @options = options.slice!(VALID_OPTIONS)
+    end
+
+    def columns *attributes
+      defaults = attributes.extract_options!
+
+      attributes.each do |name|
+        model.add_column name, defaults
+      end
+    end
+
+    def deployable_records
+      @klass.select(columns_for_select).send(defined_scope)
+    end
+
+    private
+
+    def columns_for_select
+      model.columns.collect(&:for_select)
+    end
+
+    def defined_scope
+      @options[:scope] || DEFAULT_SCOPE
+    end
+
+    def model
+      @models[@klass.to_s.to_sym] ||= RecordFormatter::Model.new
+    end
+
+  end
+end

data/lib/record_formatter/column.rb

@@ -0,0 +1,27 @@
+require 'active_support/core_ext/hash/slice'
+
+module RecordFormatter
+  class Column
+
+    VALID_OPTIONS = %i(alias)
+
+    attr_reader :name, :options
+
+    def initialize name, options={}
+      @name = name
+      @options = options.slice!(VALID_OPTIONS)
+    end
+
+    def for_select
+      "#{name} AS #{name_alias}"
+    end
+
+    private
+
+    def name_alias
+      return options[:alias] if options.key? :alias
+      name
+    end
+
+  end
+end

data/lib/record_formatter/model.rb

@@ -0,0 +1,22 @@
+module RecordFormatter
+  class Model
+
+    attr_accessor :columns
+
+    def initialize
+      @columns = []
+    end
+
+    def add_column name, options={}
+      @columns.delete(name) if columns.include?(name)
+      @columns << add_column_internal(name, options)
+    end
+
+    private
+
+    def add_column_internal name, options
+      RecordFormatter::Column.new name, options
+    end
+
+  end
+end

data/lib/record_formatter/version.rb

@@ -0,0 +1,3 @@
+module RecordFormatter
+  VERSION = "0.0.2"
+end

data/lib/tasks/record_formatter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :record_formatter do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "record_formatter"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end