knuckles 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb83d5d1b1dd47e62ea44595951f957304215bc2
+  data.tar.gz: a7ca90254ffad1b2a5c7d901ffb00bd18a0cce07
+SHA512:
+  metadata.gz: 3f705fab0c4141190600d8c7179cb0f5ef9db0fd408fa978377ec0fb8c8e01bcb6d9b266049ba7c86bc30753eb6d4afa4586fa099396792609375122be967e4b
+  data.tar.gz: df014c860e15f578d98c9cdb5f6a5ab264da0451923b3647f17eca26d6ebe440f7d88f1b51c8ca61fb4a32936fbd7a2b55821f176d4d583549f87f322b8277a1

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+TODO.md

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  Exclude:
+    - 'bench/**/*'
+    - 'bin/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Documentation is coming
+Style/Documentation:
+  Enabled: false
+
+# Extend self preserves private methods
+Style/ModuleFunction:
+  Enabled: false
+
+Style/PredicateName:
+  NamePrefix:
+    - is_
+  NamePrefixBlacklist:
+    - is_
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Style/IndentArray:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+bundler_args: --without benchmarking

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0 - 2016-03-21
+
+* Initial release (third time's the charm).

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rubocop", require: false
+gem "coveralls", require: false
+
+group :benchmarking do
+  gem "benchmark-ips"
+  gem "stackprof"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Parker Selbert
+
+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,77 @@
+[![Build Status](https://travis-ci.org/sorentwo/knuckles.svg?branch=master)](https://travis-ci.org/sorentwo/knuckles)
+[![Coverage Status](https://coveralls.io/repos/github/sorentwo/knuckles/badge.svg?branch=master)](https://coveralls.io/github/sorentwo/knuckles?branch=master)
+[![Code Climate](https://codeclimate.com/github/sorentwo/knuckles/badges/gpa.svg)](https://codeclimate.com/github/sorentwo/knuckles)
+
+# Knuckles (Because Sonic was Taken)
+
+What's it all about?
+
+* Emphasis on caching as a composable operation
+* Reduced object instantiation
+* Complete instrumentation of every discrete operation
+* Entirely agnostic, can be dropped into any project and integrated over time
+* Minimal runtime dependencies
+* Explicit serializer view API with as little overhead and no DSL
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "knuckles"
+```
+
+## Configuration
+
+There isn't a hard dependency on `Oj` or `Readthis`, but you'll find they are
+drastically more performant.
+
+```ruby
+require "activesupport"
+require "oj"
+require "readthis"
+
+Knuckles.configure do |config|
+  config.cache = Readthis::Cache.new(
+    marshal: Oj,
+    compress: true,
+    driver: :hiredis
+  )
+
+  config.keygen = Readthis::Expanders
+  config.serializer = Oj
+end
+```
+
+With the top level module configured it is simple to jump right into rendering,
+but we'll look at configuring the pipeline first.
+
+## Defining Views
+
+The interface for defining serializers is largely based on Active Model
+Serializers, but with a few key differences.
+
+```ruby
+class ScoutSerializer
+  include Knuckles::Serializer
+
+  root 'scout'
+
+  attributes :id, :email, :display_name
+
+  has_one  :thing, serializer: ThingSerializer
+  has_many :other, serializer: OtherThingSerializer
+
+  def display_name(object, options)
+    "#{object.first_name} #{object.last_name}"
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/sorentwo/knuckles/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/bench/bench_helper.rb

@@ -0,0 +1,48 @@
+require "bundler"
+
+Bundler.setup
+
+require "active_support/cache"
+require "benchmark/ips"
+require "json"
+require "knuckles"
+require_relative "fixtures/serializers"
+
+class BenchModel
+  attr_reader :key
+
+  def initialize(key, attributes)
+    attributes.each do |key, value|
+      self.class.send(:define_method, key) { value }
+    end
+  end
+
+  def cache_key
+    "#{key}/#{id}/#{updated_at}"
+  end
+end
+
+module BenchHelper
+  extend self
+
+  def submissions
+    mapping = %w[scout responses tags]
+    loaded  = JSON.load(IO.read("bench/fixtures/submissions.json"))
+
+    loaded.map do |object|
+      mapping.each do |key|
+        object[key] = structify(key, object[key])
+      end
+
+      structify('submissions', object)
+    end
+  end
+
+  def structify(key, object)
+    if object.is_a?(Array)
+      object.map { |obj| BenchModel.new(key, obj) }
+    else
+      BenchModel.new(key, object)
+    end
+  end
+end

data/bench/fixtures/serializers.rb

@@ -0,0 +1,93 @@
+module ScoutView
+  extend Knuckles::View
+
+  def self.root
+    :scouts
+  end
+
+  def self.data(object, _)
+    { id: object.id,
+      first_name: object.first_name,
+      gender: object.gender,
+      city: object.city,
+      state: object.state,
+      country: object.country,
+      education: object.education,
+      employment_status: object.employment_status,
+      ethnicity: object.ethnicity,
+      household_composition: object.household_composition,
+      household_income: object.household_income,
+      industry: object.industry,
+      created_at: object.created_at,
+      updated_at: object.updated_at }
+  end
+end
+
+module ResponseView
+  extend Knuckles::View
+
+  def self.root
+    :responses
+  end
+
+  def self.data(object, _)
+    { id: object.id,
+      answers: object.answers,
+      question_id: object.question_id,
+      respondable_id: object.respondable_id,
+      longitude: object.longitude,
+      latitude: object.latitude,
+      time_zone: object.time_zone,
+      answered_at: object.answered_at,
+      created_at: object.created_at,
+      updated_at: object.updated_at }
+  end
+end
+
+module TagView
+  extend Knuckles::View
+
+  def self.root
+    :tags
+  end
+
+  def self.data(object, _)
+    { id: object.id,
+      parent_id: object.parent_id,
+      name: object.name,
+      group: object.group,
+      auto_tag: object.auto_tag,
+      keywords: object.keywords,
+      created_at: object.created_at,
+      updated_at: object.updated_at }
+  end
+end
+
+module SubmissionView
+  extend Knuckles::View
+
+  def self.root
+    :submissions
+  end
+
+  def self.data(object, _)
+    { id: object.id,
+      screener_id: object.screener_id,
+      rating: object.rating,
+      latitude: object.latitude,
+      longitude: object.longitude,
+      source: object.source,
+      time_zone: object.time_zone,
+      bookmarks_count: object.bookmarks_count,
+      notes_count: object.notes_count,
+      finished_at: object.finished_at,
+      created_at: object.created_at,
+      updated_at: object.updated_at }
+  end
+
+  def self.relations(object, _)
+    { scouts: has_one(object.scout, ScoutView),
+      responses: has_many(object.responses, ResponseView),
+      tags: has_many(object.tags, TagView) }
+  end
+end