record_encoder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06488079297bd10fe0c38e7370bf28071868c0a4
+  data.tar.gz: ec71753742380944d794e5ca50f02d559802d8ee
+SHA512:
+  metadata.gz: 51143af570a3ecb9c73866683fefccb67da05c74a6e89a6cf1e4d3f9dab0a9e66b5980e6941e83e8e0fe2e71262566d3083c0358ae0ca471e13195dbb48206cf
+  data.tar.gz: 42ee8ba6b73492c98df416c116e14ca0c727577388392d398017e7a37a1f8cbe4cc979ad12394615a69351b44194456c5dc1b73081521163d4654a39fb0f9049

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 @@
+RecordEncoder
+============
+
+RecordEncoder can be chained to an activerecord relation or a class and will yield encoded representation
+
+
+Installation
+-----------
+
+    gem install record_encoder
+
+or by including this line in your Gemfile
+
+    gem "record_encoder", :git => "git://github.com/tskorupa/record_encoder.git"
+
+Usage
+-----
+
+    require 'record_encoder'
+
+    Class Foo < ActiveRecord::Base
+      acts_as_record_encoder
+    end
+
+    irb(main):004:0> Foo.to_bert {|r| puts r.inspect }
+    "\x83l\x00\x00\x00\x01h\x02d\x00\tfoos"
+       (0.7ms)  SELECT COUNT(*) FROM "foos"
+    "l\u0000\u0000\u0000\u0000"
+      Foo Load (0.5ms)  SELECT  "foos".* FROM "foos"   ORDER BY "foos"."id" ASC LIMIT 1000
+    "j"
+    "j"
+    => nil
+    irb(main):005:0>
+
+TODO
+================
+

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    = 'RecordEncoder'
+  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_encoder.rb

@@ -0,0 +1,29 @@
+require 'active_support/concern'
+require 'record_encoder/bert'
+
+module RecordEncoder
+  extend ActiveSupport::Concern
+
+  included do
+  end
+
+  module ClassMethods
+
+    def acts_as_record_encoder *attributes
+      @record_encoders ||= {}
+      @record_encoders[:bert] ||= RecordEncoder::Bert.new self, *attributes
+
+      extend RecordEncoder::LocalClassMethods
+    end
+
+  end
+
+  module LocalClassMethods
+    def to_bert
+      @record_encoders[:bert].to_bert {|r| yield r }
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :include, RecordEncoder

data/lib/record_encoder/bert.rb

@@ -0,0 +1,97 @@
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/string/inflections'
+require 'bert'
+
+module RecordEncoder
+  class Bert
+
+    SUPPORTED_OPTIONS = %i( primary_key delete_primary_key )
+
+    def initialize klass, *attributes
+      @klass = klass
+      raise "klass can't be blank!" if @klass.blank?
+      raise "klass must be a Class!" unless @klass.is_a? Class
+
+      options = attributes.extract_options!.slice!(SUPPORTED_OPTIONS)
+      @primary_key = options[:primary_key] || :id
+      @delete_primary_key = options[:delete_primary_key] || true
+
+      bert_prefix_and_suffix
+    end
+
+    def to_bert
+      to_bert_internal {|r| yield r }
+      nil
+    end
+
+    private
+
+    def to_bert_internal
+      yield @bert_prefix
+      yield records_list_prefix
+      @klass.find_each do |record|
+        yield record_bert( record )
+      end
+      yield records_list_suffix
+      yield @bert_suffix
+    end
+
+    # NOTE: records_list_prefix needs to be computed dynamically. no caching
+    def records_list_prefix
+      "l" + [records_count].pack("N").bytes.pack('c*')
+    end
+
+    def records_list_suffix
+      "j"
+    end
+
+    # NOTE: records_count needs to be computed dynamically. no caching
+    def records_count
+      @klass.all.size
+    end
+
+    def encode datum, opts={}
+      bert = BERT.encode( datum )
+      bert = bert[1..-1] if opts.present? && opts[:offset].present?
+      bert
+    end
+
+    def record_bert record
+      encode record_tuple(record), offset: true
+    end
+
+    def record_tuple record
+      # TODO: to enhanced performance, 'record_attributes_tuple_collection(record)' could be
+      #   precomputed as a record column and accessed here directly
+      tuple record.send(@primary_key), record_attributes_tuple_collection(record)
+    end
+
+    def record_attributes_tuple_collection record
+      record_hash(record).collect {|k,v| tuple(k,v) }
+    end
+
+    def record_hash record
+      hash = record.serializable_hash.deep_symbolize_keys
+      hash.delete(@primary_key) if @delete_primary_key
+      hash
+    end
+
+    def tuple key, value
+      t[key, value]
+    end
+
+    def bert_prefix_and_suffix
+      placeholder = [:placeholder]
+      bert = encode( [ tuple(bert_name, placeholder) ] )
+      placeholder_list = encode(placeholder, offset: true)
+      @bert_prefix, @bert_suffix = bert.split( placeholder_list )
+    end
+
+    def bert_name
+      @bert_name ||= @klass.to_s.underscore.pluralize.to_sym
+    end
+
+  end
+end

data/lib/record_encoder/version.rb

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

data/lib/tasks/record_encoder_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :record_encoder 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_encoder"
+
+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