stairwell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16226c907ec3dc09521135fd9daf686284c6f7520a7abd3672517fe6b81f1614
+  data.tar.gz: f4ffdb12c04f2fa6dc4cf2f0451790f86dfd66bf2e11af3c0ca265a9d05cd92c
+SHA512:
+  metadata.gz: 801f301a216a8e5cce25b1e1ec4a6a821b23636b1a07d817d61924b363f3febbbedd9aa77ad6757d954ac682747efc2df45f03107d7f24aed3a3a33039a2bd7a
+  data.tar.gz: 3bac00beda3087c312582d7bd1d187ba06c607190ab8a3ed02c2fc45bd47cffb98a02090bb5be207ebd15b7515b64711b486c0eba9526cc4b6f061887cbdbdeb

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in stairwell.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    stairwell (0.1.0)
+      zeitwerk (~> 2.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  pry
+  rake (~> 12.0)
+  stairwell!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Toby
+
+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,101 @@
+# Stairwell
+
+Making SQL more accessible while maintaining safety in Rails projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stairwell'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install stairwell
+
+## Usage
+
+Define a class in your app that inherits from `Stairwell::Query`. We're going to assume you are in a rails app, but this will work in any ruby app, ActiveRecord is not a dependency here.
+In rails you could create a directory called `app/queries` for instance.
+
+Define your `validate_type`, which will be the arguments you send in, and their type. For instance, if your query looks like this: `SELECT * FROM users WHERE name = :name`, and name is a `String`, your `validate_type` will look like this `validate_type :name, :string`, and you'll pass in a hash of your binds like this: `{ name: "<name value>" }`
+
+Here's an example:
+```ruby
+class UsersSql < Stairwell::Query
+  validate_type :name, :string
+  validate_type :age, :integer
+  validate_type :active, :boolean
+  validate_type :gpa, :float
+  validate_type :date_joined, :sql_date
+  validate_type :created_at, :sql_date_time
+
+  query <<-SQL
+    SELECT
+      *
+    FROM users
+    WHERE name = :name
+      AND age = :age
+      AND active = :active
+      AND gpa = :gpa
+      AND date_joined = :date_joined
+      AND created_at >= :created_at
+    ;
+  SQL
+end
+
+# if you pass in the following named binds:
+
+binds = {
+  name: "First",
+  age: 99,
+  active: true,
+  gpa: 4.2
+  date_joined: "2008-08-28",
+  created_at: "2008-08-28 23:41:18",
+}
+
+# and call the following:
+
+UsersSql.sql(binds)
+
+# You will receive the following result:
+
+"SELECT * FROM users WHERE name = 'First' age = 99 active = TRUE date_joined = '2008-08-28' created_at = '2008-08-28 23:41:18' gpa = 4.2;"
+```
+
+Binds passed in are validated against the validate_type, so if you have a validate_type you must include that value in your binds hash.
+They types of the binds are validated too.
+The names binds in your sql are also validated.
+Strings are quoted. Dates are quoted. Datetime is quoted.
+
+Tested in both Mysql and Postgres.
+
+## Known issues
+
+* nil/NULL values are not currently supported. Just use `IS NULL` or `IS NOT NULL` in your query for the time being.
+* Date/Datetime are not validated for their format, it is expected that you will pass the correct format.
+* Datetime in postgres is not currently working for equality, only for `>` or `<` or `>=` or `<=`
+* Column/table quoting is not currently available.
+* `IN` statements with arrays support is forthcoming.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tobyond/stairwell.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stairwell"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/stairwell.rb

@@ -0,0 +1,14 @@
+require "date"
+require "zeitwerk"
+require "ostruct"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module Stairwell
+  class Error < StandardError; end
+  class InvalidBindType < StandardError; end
+  class InvalidBindCount < StandardError; end
+  class SqlBindMismatch < StandardError; end
+end
+
+loader.eager_load

data/lib/stairwell/bind_transformer.rb

@@ -0,0 +1,44 @@
+module Stairwell
+  class BindTransformer
+
+    attr_accessor :sql, :bind_hash, :depleting_bind_hash
+
+    def initialize(sql, bind_hash)
+      @sql = sql
+      @bind_hash = bind_hash
+      @depleting_bind_hash = bind_hash.dup
+    end
+
+    # taking the sql string like "SELECT * WHERE name = :name AND id = :id"
+    # and confirming that the bind_hash has all the named binds like
+    # { name: "First", id: 22 }
+    # if the sql string or the bind_hash have incorrect or extra values
+    # and error will raise
+    # The sql string will then have the appropropriate values substituted
+    # with quoted values to ensure safety.
+    # Note: $2 is The match for the first, second, etc. parenthesized groups in the last regex
+    def transform
+      converted_sql = sql.gsub(/(:?):([a-zA-Z]\w*)/) do |_|
+        replace = $2.to_sym
+        validate_sql(replace)
+        bind_hash[replace].sql_quote
+      end
+
+      validate_bind_hash
+      converted_sql
+    end
+
+    private
+
+      def validate_sql(attr)
+        raise SqlBindMismatch, ":#{attr} in your query is missing from your bind hash: #{bind_hash}" unless bind_hash[attr]
+
+        depleting_bind_hash.delete(attr)
+      end
+
+      def validate_bind_hash
+        raise SqlBindMismatch, "#{depleting_bind_hash} in your bind hash is missing from your query: #{sql}" unless depleting_bind_hash.empty?
+      end
+
+  end
+end

data/lib/stairwell/core_extensions/core.rb

@@ -0,0 +1,73 @@
+module Stairwell::CoreExtensions::Core; end
+
+class String
+  def squish!
+    gsub!(/[[:space:]]+/, " ")
+    strip!
+    self
+  end
+
+  def underscore
+    self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end
+
+  def sql_quote
+    "'#{self.gsub('\\', '\&\&').gsub("'", "''")}'"
+  end
+end
+
+class TrueClass
+  def sql_quote
+    "TRUE"
+  end
+end
+
+class FalseClass
+  def sql_quote
+    "FALSE"
+  end
+end
+
+class NilClass
+  def sql_quote
+    "IS NULL"
+  end
+end
+
+class Integer
+  def sql_quote
+    self
+  end
+end
+
+class Float
+  def sql_quote
+    self
+  end
+end
+
+class Date
+  def self.parsable?(string)
+    begin
+      parse(string)
+      true
+    rescue ArgumentError
+      false
+    end
+  end
+end
+
+class DateTime
+  def self.parsable?(string)
+    begin
+      parse(string)
+      true
+    rescue ArgumentError
+      false
+    end
+  end
+end

data/lib/stairwell/core_extensions/types.rb

@@ -0,0 +1,9 @@
+module Stairwell::CoreExtensions::Types; end
+
+module Boolean; end
+class TrueClass; include Boolean; end
+class FalseClass; include Boolean; end
+
+module SqlDate; end
+module SqlDateTime; end
+class String; include SqlDate; include SqlDateTime; end

data/lib/stairwell/query.rb

@@ -0,0 +1,45 @@
+module Stairwell
+  class Query
+
+    class << self
+      attr_accessor :bind_hash, :all_validations, :sql_string, :bind_object_array
+
+      def validate_type(*args)
+        @all_validations ||= {}
+        @all_validations.merge!(Hash[*args])
+      end
+
+      def sql(**args)
+        @bind_hash = args
+        @bind_object_array = []
+        validate!
+        transformed_sql_string
+      end
+
+      def query(string)
+        @sql_string = string
+      end
+
+      private
+
+        def validate!
+          raise InvalidBindCount.new("Incorrect amount of args passed") unless correct_args?
+
+          bind_hash.each do |bind_name, bind_value|
+            type = all_validations[bind_name]
+            valid = TypeValidator.send(type, bind_value)
+
+            raise InvalidBindType.new("#{bind_name} is not #{all_validations[bind_name]}") unless valid
+          end
+        end
+
+        def transformed_sql_string
+          BindTransformer.new(sql_string.squish!, bind_hash).transform
+        end
+
+        def correct_args?
+          bind_hash.keys.sort == all_validations.keys.sort
+        end
+    end
+  end
+end

data/lib/stairwell/type_validator.rb

@@ -0,0 +1,24 @@
+require "stairwell/core_extensions/types"
+require "stairwell/core_extensions/core"
+
+module Stairwell
+  class TypeValidator
+
+    class << self
+      TYPES = [
+        String,
+        Boolean,
+        Integer,
+        Float,
+        SqlDate,
+        SqlDateTime
+      ].freeze
+
+      TYPES.each do |type|
+        define_method(type.to_s.underscore.to_sym) do |arg|
+          arg.is_a?(type)
+        end
+      end
+    end
+  end
+end

data/lib/stairwell/version.rb

@@ -0,0 +1,3 @@
+module Stairwell
+  VERSION = "0.1.0"
+end

data/stairwell.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/stairwell/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stairwell"
+  spec.version       = Stairwell::VERSION
+  spec.authors       = ["tobyond"]
+
+  spec.summary       = %q{stairwell for sql}
+  spec.description   = %q{Sanitize and quote raw SQL for rails and any project in ruby}
+  spec.homepage      = "https://github.com/tobyond/stairwell"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/tobyond/stairwell"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'zeitwerk', '~> 2.4.0'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: stairwell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tobyond
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+description: Sanitize and quote raw SQL for rails and any project in ruby
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stairwell.rb
+- lib/stairwell/bind_transformer.rb
+- lib/stairwell/core_extensions/core.rb
+- lib/stairwell/core_extensions/types.rb
+- lib/stairwell/query.rb
+- lib/stairwell/type_validator.rb
+- lib/stairwell/version.rb
+- stairwell.gemspec
+homepage: https://github.com/tobyond/stairwell
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tobyond/stairwell
+  source_code_uri: https://github.com/tobyond/stairwell
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: stairwell for sql
+test_files: []