sqlite_ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 358578932f13ad9c22b55c08e6f88e7df49393c2
+  data.tar.gz: c77427cefe98e3e0aee5f76e081e656775c6d67b
+SHA512:
+  metadata.gz: fe6e7ed5b9b87d7686c6396b8fed5a820eef53017db82180ec3360447039912e3534901a4f63339e6680ffe897308ba6f4ee1a6f620b14270ec15a58583743c7
+  data.tar.gz: 1c28171d818e554cf7f24c985676b8310bd53e49424ad65bd70f44f3cbe0a11625384e417a0ac05865421edff70dbe3d5ee0052a6caf92a19cd5754c33c9c040

data/.gitignore

@@ -0,0 +1,10 @@
+.ruby-version
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at stevej@stevej.name. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sqlite_ext.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Steve Jorgensen
+
+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,71 @@
+# SqliteExt
+
+Note that the work on this gem is still in the early stages, so
+the text below represents what it is intended to do. The gem does
+not yet accomplish all of that as of yet.
+
+Provides a convenient way of writing functions in Ruby that can
+be called from with in SQLite queries through the SQLite3 gem.
+
+Although it is already possible to write ruby code for functions
+that can be called from within SQL queries using SQLite via the
+SQLite3 gem, that has some limitations which this gem seeks to
+address.
+
+First, when utilizing `SQLite3::Database#create_function`, the
+added function only exists for the current instance of
+`SQLite3::Database`. If that instance is being accessed through
+a connection pool (e.g. via ActiveRecord) then there it is hard
+to ensure that the functions are created on each new instance
+before the SQL that needs them to exist is executed.
+
+Secondly, the Ruby code needed to define a trivial SQL-callable
+function using `SQLite3::Database#create_function` is fairly
+verbose, and it would be nice to have a simpler API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sqlite_ext'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sqlite_ext
+
+## Usage
+
+    SqliteExt.register_create_function 'sqrt', 1 do |fn,x|
+      fn.result =
+        case x
+        when nil then nil
+        else Math.sqrt(x)
+        end
+    end
+
+    SQLite3::Database.new 'data.db' do |db|
+      puts db.execute("SELECT sqrt(25)")[0][0]
+    end
+    # Output: 5.0
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/stevecj/sqlite_ext. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sqlite_ext"
+
+# 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

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/sqlite_ext/init_injection.rb

@@ -0,0 +1,15 @@
+module SqliteExt
+  module InitInjection
+    def initialize(file, *other_init_args)
+      if block_given?
+        super file, *other_init_args do |db|
+          SqliteExt.enhance_db_session self
+          yield db
+        end
+      else
+        db = super
+        SqliteExt.enhance_db_session db
+      end
+    end
+  end
+end

data/lib/sqlite_ext/version.rb

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

data/lib/sqlite_ext.rb

@@ -0,0 +1,82 @@
+gem "sqlite3"
+require "sqlite3"
+
+module SqliteExt
+
+  require "sqlite_ext/version"
+  require "sqlite_ext/init_injection"
+
+end
+
+class SQLite3::Database
+  prepend SqliteExt::InitInjection
+end
+
+module SqliteExt
+
+  class << self
+
+    # Registers a #create_function call to be invoked on every
+    # new instance of `SQLite3::Database` immidately after it is
+    # instantiated and before it is returned from the call to
+    # `.new` and before the invocation of a block that is passed
+    # to `.new`.
+    #
+    # Note that this only affects instances of
+    # `SQLite3::Database` that are subsequently created and has
+    # no effect on previously created instances.
+    #
+    # Example:
+    #
+    #  SqliteExt.register_create_function 'sqrt', 1 do |fn,x|
+    #     fn.result =
+    #       case x
+    #         when nil then nil
+    #         else Math.sqrt(x)
+    #         end
+    #       end
+    #
+    #       SQLite3::Database.new 'data.db' do |db|
+    #         puts db.execute("SELECT sqrt(25)")[0][0]
+    #       end
+    #       # Output: 5.0
+    def register_create_function(name, arity, *other_args, &block)
+      name = "#{name}"
+      registered_function_creations[name] = [
+        [name, arity, *other_args],
+        block
+      ]
+    end
+
+    # Returns an array of the names of all currently registered
+    # functions.
+    def registered_function_names
+      registered_function_creations.keys
+    end
+
+    # Removes all function registrations. Has no effect on
+    # existing instances of `SQLite3::Database`.
+    def purge_function_registrations
+      registered_function_creations.clear
+    end
+
+    # Creates all of the registered functions on an instance of
+    # `SQLite3::Database`.
+    #
+    # This is normally called automatically for each new
+    # instance, but can also be used to add the functions to
+    # an instance that was created before the functions were
+    # registered.
+    def enhance_db_session(db)
+      registered_function_creations.each_value do |(args,block)|
+        db.create_function *args, &block
+      end
+    end
+
+    private
+
+    def registered_function_creations
+      @registered_function_creations ||= {}
+    end
+  end
+end

data/sqlite_ext.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sqlite_ext/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sqlite_ext"
+  spec.version       = SqliteExt::VERSION
+  spec.authors       = ["Steve Jorgensen"]
+  spec.email         = ["stevej@stevej.name"]
+
+  spec.summary       = "Provides a convenient way of writing functions in Ruby that can " \
+                       "be called from with in SQLite queries through the SQLite3 gem."
+  spec.homepage      = "https://github.com/stevecj/sqlite_ext"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sqlite3", "~> 1.3"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: sqlite_ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Jorgensen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- stevej@stevej.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data.db
+- foo.db
+- lib/sqlite_ext.rb
+- lib/sqlite_ext/init_injection.rb
+- lib/sqlite_ext/version.rb
+- sqlite_ext.gemspec
+homepage: https://github.com/stevecj/sqlite_ext
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Provides a convenient way of writing functions in Ruby that can be called
+  from with in SQLite queries through the SQLite3 gem.
+test_files: []