assorted 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91e2d41bfce1a1dc7df96c83a9b5d5baa6fc939f
+  data.tar.gz: 71b2621335edd05c40d5ddd7c7c5ab96760aa916
+SHA512:
+  metadata.gz: 90c0b02d1554a2ca14b35f82eb329dcc6af33672c31e93616406546dfaefcb9a5bfec7b692c64e54b364131a594243ffbc4f24b263825eac7e616349acec3047
+  data.tar.gz: a213cf2f5f0ce389298e54daef8f47ffe5f2433f6eddd1cf49e325f213fbc7e5b71a53b1af3609b4363a3b5faa4abbd956e897c2805d5396baa66197c65f3fec

data/lib/assorted/scopes.rb

@@ -0,0 +1,29 @@
+module Assorted
+  module Scopes
+    def asc(column = sorting_column)
+      sanitized_order(column, :asc)
+    end
+
+    def desc(column = sorting_column)
+      sanitized_order(column, :desc)
+    end
+
+    def sorting_column
+      @sorting_column ||= :created_at
+    end
+
+    def sorting_column=(column)
+      @sorting_column = column
+    end
+
+    private
+
+    def sanitized_order(column, direction)
+      if attribute_names.include?(column.to_s)
+        order("#{table_name}.#{column} #{direction}")
+      else
+        raise ActiveRecord::StatementInvalid, "Unknown column #{column}"
+      end
+    end
+  end
+end

data/lib/assorted/version.rb

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

data/lib/assorted.rb

@@ -0,0 +1,8 @@
+require "active_record"
+
+require "assorted/version"
+require "assorted/scopes"
+
+ActiveSupport.on_load(:active_record) do
+  extend Assorted::Scopes
+end

data/spec/lib/assorted/scopes_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+RSpec.describe Assorted::Scopes do
+  it "sorts by created_at by default" do
+    first = ExampleRecord.create(created_at: 2.days.ago)
+    second = ExampleRecord.create(created_at: 1.day.ago)
+
+    expect(ExampleRecord.asc).to eq([first, second])
+    expect(ExampleRecord.desc).to eq([second, first])
+  end
+
+  it "sorts by the given column, if provided" do
+    more = ExampleRecord.create(example_count: 2)
+    less = ExampleRecord.create(example_count: 1)
+
+    expect(ExampleRecord.asc(:example_count)).to eq([less, more])
+    expect(ExampleRecord.desc(:example_count)).to eq([more, less])
+  end
+
+  it "prevents SQL injection attacks" do
+    record = ExampleRecord.create
+    injection_attempt = "created_at desc; delete * from example_records;"
+
+    expect { ExampleRecord.asc(injection_attempt) }.to raise_exception(ActiveRecord::StatementInvalid)
+    expect(ExampleRecord.count).to eq(1)
+  end
+
+  it "allows an alternate default sorting column to be supplied" do
+    more = ExampleRecord.create(example_count: 2)
+    less = ExampleRecord.create(example_count: 1)
+
+    ExampleRecord.sorting_column = :example_count
+
+    expect(ExampleRecord.asc).to eq([less, more])
+    expect(ExampleRecord.desc).to eq([more, less])
+  end
+end

data/spec/lib/assorted_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+RSpec.describe Assorted do
+  it "includes itself in ActiveRecord::Base" do
+    expect(ActiveRecord::Base.ancestors).to include(Assorted::Scopes)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,70 @@
+require "assorted"
+
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each do |file|
+  require file
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 5 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 5
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/active_record.rb

@@ -0,0 +1,31 @@
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: "spec/test.db")
+
+class ExampleRecord < ActiveRecord::Base
+end
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      ActiveRecord::Migration.verbose = false
+      ActiveRecord::Migration.create_table(:example_records) do |table|
+        table.integer :user_id
+        table.integer :example_count
+        table.timestamps
+      end
+
+      original_sorting_column = ExampleRecord.sorting_column
+
+      example.run
+
+      ExampleRecord.sorting_column = original_sorting_column
+
+      raise ActiveRecord::Rollback
+    end
+  end
+
+  config.after(:suite) do
+    ActiveRecord::Base.connection.instance_variable_get("@config").tap do |configuration|
+      File.delete(configuration[:database])
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: assorted
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patrick Byrne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- code@patrickbyrne.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/assorted.rb
+- lib/assorted/scopes.rb
+- lib/assorted/version.rb
+- spec/lib/assorted/scopes_spec.rb
+- spec/lib/assorted_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: https://github.com/dribbble/assorted
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Add sorting scopes `asc` and `desc` to your ActiveRecord models.
+test_files:
+- spec/lib/assorted/scopes_spec.rb
+- spec/lib/assorted_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb