pick_a_record 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9b03aee74dc4e3304fa9b8b35147024fa7b71a7
+  data.tar.gz: 65be33658d3bb0173b1bd38f8e44e132ebba422f
+SHA512:
+  metadata.gz: 59a54cfe12be9a8fef8aaca5be2ce317affe0c8c8a848c6de84d8339d9096266259212ea58df097fdd832c423fb2b145511cc1304cff9baf04c9ad034e0faf95
+  data.tar.gz: c9cdb739e2b2fed82568285f3b4f8225169a4bdef02fa38bb47189b7111882e5bfd99c431fcd6be16fa75a32961f501dc93608306e70d25737eaea67fed809d3

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.md

@@ -0,0 +1,30 @@
+# PickARecord
+
+Very alpha. Wow. Such risk of API breakage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+	gem 'pick_a_record'
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install pick_a_record
+
+## 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,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PickARecord'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/pick_a_record/application.js

@@ -0,0 +1,15 @@
+// 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/pick_a_record/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/pick_a_record/application_controller.rb

@@ -0,0 +1,4 @@
+module PickARecord
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/pick_a_record/application_helper.rb

@@ -0,0 +1,4 @@
+module PickARecord
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/pick_a_record/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>PickARecord</title>
+  <%= stylesheet_link_tag    "pick_a_record/application", :media => "all" %>
+  <%= javascript_include_tag "pick_a_record/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+PickARecord::Engine.routes.draw do
+end

data/lib/pick_a_record/engine.rb

@@ -0,0 +1,18 @@
+module PickARecord
+  class Engine < ::Rails::Engine
+    isolate_namespace PickARecord
+
+    initializer 'pick_a_record.time_stub' do
+      Time.send(:include, PickARecord::TimeExtensions)
+    end
+
+    initializer 'pick_a_record.active_record_integration' do
+      ActiveSupport.on_load(:active_record) do
+        ::ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:include, PickARecord::RandomFunction)
+
+        include PickARecord::InRandomOrder
+        include PickARecord::SelectorHelpers
+      end
+    end
+  end
+end

data/lib/pick_a_record/in_random_order.rb

@@ -0,0 +1,19 @@
+module PickARecord::InRandomOrder
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # Return the first `n` record(s) in random order.
+    # @param [Integer] n
+    # @return [ActiveRecord::Relation]
+    def first_random(n = 1)
+      n = n.to_i.nonzero? || 1
+
+      limit(n).in_random_order
+    end
+
+    # @return [ActiveRecord::Relation]
+    def in_random_order
+      reorder(connection.random_function)
+    end
+  end
+end

data/lib/pick_a_record/random_function.rb

@@ -0,0 +1,15 @@
+# Mixin for ActiveRecord::ConnectionAdapters::AbstractAdapter
+module PickARecord::RandomFunction
+  # The SQL Standard function for randomization
+  # @return [String]
+  STANDARD_RANDOM = 'RANDOM()'
+
+  # MySQL's abbreviated function for randomization
+  # @return [String]
+  MYSQL_RANDOM    = 'RAND()'
+
+  # @return [String]
+  def random_function
+    @random_function ||= adapter_name =~ /mysql/i ? MYSQL_RANDOM : STANDARD_RANDOM
+  end
+end

data/lib/pick_a_record/selector.rb

@@ -0,0 +1,164 @@
+# Module subclass for generating a cached random record.
+class PickARecord::Selector < Module
+  HOUR  = 1.hour
+  DAY   = 1.day
+  WEEK  = 1.week
+
+  include Calculi::HasFunctionSet
+
+  calculi_string    :name
+  calculi_string    :prefix, default: 'random'
+  calculi_int       :store_last, default: 5
+  calculi_duration  :duration, default: 1.day
+
+  # @!attribute [rw] source_scope
+  #   The source to draw a random record from.
+  #   @return [Proc, Symbol]
+  calculi_procable  :source_scope
+
+  calculi_computed :full_name do
+    [prefix, name].compact.join('_').to_sym
+  end
+
+  options! :name, prefix: 'random', store_last: 5, duration: 1.day
+
+  # @!group Duration attributes
+
+  # @return {Boolean}
+  def hourly?
+    duration == HOUR
+  end
+
+  # @return [Boolean]
+  def daily?
+    duration == DAY
+  end
+
+  # @return [Boolean]
+  def weekly?
+    duration == WEEK
+  end
+  # @!endgroup
+
+  calculi_functions do
+    function :cache_key do
+      name { "#{full_name}_cache_key" }
+
+      body do |target, fn, args|
+        [self, "#{target.full_name}"]
+      end
+    end
+
+    function :last_records_cache_key do
+      name { "last_#{full_name}_cache_key" }
+
+      body do |target, fn, args|
+        "#{self}.last_#{target.full_name}_ids"
+      end
+    end
+
+    function :last_records_list, memoize: true do
+      name { "last_#{full_name}_ids" }
+
+      requires :last_records_cache_key
+
+      body do |target, fn, args|
+        ::Redis::List.new(fn[:last_records_cache_key], max_length: target.store_last)
+      end
+    end
+
+    function :without_last_records do
+      name { "without_last_#{full_name}_ids" }
+
+      requires :last_records_list
+
+      body do |target, fn, args|
+        last_ids = Array(fn[:last_records_list])
+
+        last_ids.present? ? where('id NOT IN (?)', last_ids) : scoped
+      end
+    end
+
+    function :last_records_clear do
+      name { "clear_last_#{full_name}_ids!" }
+
+      requires :last_records_list
+
+      body do |target, fn, args|
+        fn[:last_records_list].clear
+      end
+    end
+
+    function :expires_in do
+      name { "#{full_name}_expires_in" }
+
+      if target.daily?
+        body { Time.now.seconds_until_end_of_day }
+      elsif target.weekly?
+        body { Time.now.seconds_until_end_of_week }
+      else
+        body do |target, fn, args|
+          target.duration
+        end
+      end
+    end
+
+    function :scope do
+      name { "scope_for_#{full_name}" }
+
+      if procable? target.source_scope
+        body do |target, fn, args|
+          instance_eval(&target.source_scope)
+        end
+      else
+        body { scoped }
+      end
+    end
+
+    function :clear! do
+      name { "clear_#{full_name}!" }
+
+      requires :cache_key
+
+      body do |target, fn, args|
+        ::Rails.cache.delete fn[:cache_key]
+      end
+    end
+
+    function :fetch_one do
+      name { "fetch_one_#{full_name}" }
+
+      requires :scope, :without_last_records
+
+      body do |target, fn, args|
+        fn.chain(:scope, :without_last_records).in_random_order.first
+      end
+    end
+
+    function :get do
+      name { "#{full_name}" }
+
+      requires :fetch_one, :remember, :cache_key, :expires_in
+
+      body do |target, fn, args|
+        ::Rails.cache.fetch fn[:cache_key], expires_in: fn[:expires_in], race_condition_ttl: 20 do
+          fn[:fetch_one].tap do |last_entry|
+            fn[:remember, last_entry]
+          end
+        end
+      end
+    end
+
+    function :remember do
+      name { "remember_#{full_name}" }
+
+      requires :last_records_list
+
+      body do |target, fn, args|
+        last_entry_id = args.first.try(:id)
+
+        fn[:last_records_list] << last_entry_id if last_entry_id.present?
+      end
+    end
+  end
+end

data/lib/pick_a_record/selector_helpers.rb

@@ -0,0 +1,27 @@
+module PickARecord::SelectorHelpers
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def pick_a_record(options = {}, &scope)
+      options.reverse_merge! name: model_name.singular, source_scope: scope
+
+      extend PickARecord::Selector.new options
+    end
+
+    def pick_a_daily(selector_name = nil, &scope)
+      options = { duration: 1.day, prefix: 'daily' }
+
+      options[:name] = selector_name if selector_name.present?
+
+      pick_a_record(options, &scope)
+    end
+
+    def pick_a_weekly(selector_name = nil, &scope)
+      options = { duration: 1.week, prefix: 'weekly' }
+
+      options[:name] = selector_name if selector_name.present?
+
+      pick_a_record(options, &scope)
+    end
+  end
+end

data/lib/pick_a_record/time_extensions.rb

@@ -0,0 +1,19 @@
+# Extra methods for the {Time} class.
+module PickARecord::TimeExtensions
+  extend ActiveSupport::Concern
+
+  included do
+    alias_method :seconds_until_end_of_day, :as4_seconds_until_end_of_day unless method_defined?(:seconds_until_end_of_day)
+  end
+
+  # @note Backport of Time#seconds_until_end_of_day from ActiveSupport 4
+  # @return [Integer] number of the seconds until the end of the day
+  def as4_seconds_until_end_of_day
+    end_of_day.to_i - to_i
+  end
+
+  # @return [Integer] number of seconds until the end of the week
+  def seconds_until_end_of_week
+    end_of_week.to_i - to_i
+  end
+end

data/lib/pick_a_record/utility.rb

@@ -0,0 +1,2 @@
+module PickARecord::Utility
+end

data/lib/pick_a_record/version.rb

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

data/lib/pick_a_record.rb

@@ -0,0 +1,14 @@
+require 'calculi'
+require 'redis-objects'
+
+module PickARecord
+  # Extensions
+  require 'pick_a_record/in_random_order'
+  require 'pick_a_record/random_function'
+  require 'pick_a_record/time_extensions'
+
+  require 'pick_a_record/selector'
+  require 'pick_a_record/selector_helpers'
+
+  require 'pick_a_record/engine'
+end

data/lib/tasks/pick_a_record_tasks.rake

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

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: pick_a_record
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexa Grey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: calculi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: redis-objects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fabrication
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pick a random record and cache the result for display.
+email:
+- devel@mouse.vc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/pick_a_record/application.js
+- app/assets/stylesheets/pick_a_record/application.css
+- app/controllers/pick_a_record/application_controller.rb
+- app/helpers/pick_a_record/application_helper.rb
+- app/views/layouts/pick_a_record/application.html.erb
+- config/routes.rb
+- lib/pick_a_record/engine.rb
+- lib/pick_a_record/in_random_order.rb
+- lib/pick_a_record/random_function.rb
+- lib/pick_a_record/selector.rb
+- lib/pick_a_record/selector_helpers.rb
+- lib/pick_a_record/time_extensions.rb
+- lib/pick_a_record/utility.rb
+- lib/pick_a_record/version.rb
+- lib/pick_a_record.rb
+- lib/tasks/pick_a_record_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/scryptmouse/pick_a_record
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.4
+signing_key: 
+specification_version: 4
+summary: Pick a random record and cache the result for display.
+test_files: []