simple-sql 0.4.22 → 0.4.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58caff3c654cc1f068e15d93f2d356fde5598e159ddd2589aeb5e5588a1e8c16
-  data.tar.gz: d9d06f994b53824b937872c548601c025a93060c917602a73e99d8a8ab24dbdd
+  metadata.gz: 27cc3b86bf4e72218ecc962cea6700d9a58e6a8ef594e15bfad16125bba792aa
+  data.tar.gz: c4642ed511a3dd94511d6a56b9c22e5bce830e15a6ecb3e2ed3a74d192253e56
 SHA512:
-  metadata.gz: af6166f4600345b8151092e3f2198f89defb2d64365a3e0d616b2da86ef87a73ba7b6ed360e3c4dd4371569afa70e210ef72bdbbabd25e5b87f685cc0d7c99ef
-  data.tar.gz: e04ef18bd368c7e2e404daf84767204335de2f85ee22594d56bd37415b085e6dc78417cd46d5e085e134493d2cb0d09318da8665a8695a1333a6e89a7c24af7c
+  metadata.gz: 886016b412df3e5ad6d3eead65a1c1c81fe8c6eb98d868f2ae479a6c18b333d68f7661a21e17a566e7cfc151d8c844fca297c86bb7170ca423ff3d97a6bace12
+  data.tar.gz: a651642b76dea15fe5d56c2311576a24d2992aa07d255aab244735c392fe7d9465a93aa255479ba2544e115162bf54b15378d718af40849d3645fbe8338eb051

data/.rubocop.yml

@@ -66,3 +66,9 @@ Style/ClassVars:
 
 Style/ConditionalAssignment:
   Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false

data/Makefile

@@ -0,0 +1,5 @@
+stats:
+	@scripts/stats lib/simple/sql
+	@scripts/stats spec/simple/sql
+	@scripts/stats lib/simple/store
+	@scripts/stats spec/simple/store

data/bin/console

@@ -1,17 +1,36 @@
 #!/usr/bin/env ruby
 $: << "lib"
 require "simple/sql"
+require "simple/store"
 
 SQL = Simple::SQL
 SQL.connect!
 
-def reload!
-  $VERBOSE = nil
-  Dir.glob("lib/simple/sql/**/*.rb").sort.each do |path|
-    STDERR.puts path
+module Reload
+  extend self
+
+  def load_file(path)
+    STDERR.puts "Loading #{path}\n"
     load path
-  end 
+  end
+
+  def load_dir(dir)
+    Dir.glob("#{dir}/**/*.rb").sort.each_with_index do |path, idx|
+      load_file path
+    end 
+  end
 end
 
+$VERBOSE = nil
+
+def reload!
+  Reload.load_dir "lib/simple"
+  Reload.load_file "config/console-init.rb"
+end
+
+Reload.load_file "config/console-init.rb"
+
 require "irb"
+require "irb/completion"
+
 IRB.start

data/bin/pg

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'yaml'
+
+env = ENV["POSTJOB_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+
+configs = YAML.load_file "config/database.yml"
+config = configs.fetch(env) { configs.fetch("defaults") }
+
+ENV["PGHOST"]     = config["host"]
+ENV["PGPORT"]     = config["port"] && config["port"].to_s
+ENV["PGUSER"]     = config["username"]
+ENV["PGPASSWORD"] = config["password"]
+
+system "psql", "-d", config.fetch("database")

data/config/console-init.rb

@@ -0,0 +1 @@
+# This file is loaded when running bin/console.

data/lib/simple/sql.rb

@@ -21,7 +21,7 @@ module Simple
   module SQL
     extend self
     extend Forwardable
-    delegate [:ask, :all, :each, :exec, :print] => :connection
+    delegate [:ask, :all, :each, :exec, :locked, :print] => :connection
     delegate [:transaction, :wait_for_notify] => :connection
 
     delegate [:logger, :logger=] => ::Simple::SQL::Logging

data/lib/simple/sql/connection.rb

@@ -14,6 +14,7 @@ module Simple::SQL::Connection
     Logging.info "Connecting to #{database_url}"
 
     raw_connection = PG::Connection.new(config)
+    raw_connection.set_notice_processor { |message| Logging.info(message) }
     PgConnection.new(raw_connection)
   end
 

data/lib/simple/sql/connection_adapter.rb

@@ -1,5 +1,3 @@
-# rubocop:disable Style/IfUnlessModifier
-
 # This module implements an adapter between the Simple::SQL interface
 # (i.e. ask, all, first, transaction) and a raw connection.
 #
@@ -83,6 +81,21 @@ module Simple::SQL::ConnectionAdapter
     end
   end
 
+  # Executes a block, usually of db insert code, while holding an
+  # advisory lock.
+  #
+  # Examples:
+  #
+  # - <tt>Simple::SQL.locked(4711) { puts 'do work while locked' }
+  def locked(lock_id)
+    begin
+      ask("SELECT pg_advisory_lock(#{lock_id})")
+      yield
+    ensure
+      ask("SELECT pg_advisory_unlock(#{lock_id})")
+    end
+  end
+
   private
 
   Encoder = ::Simple::SQL::Helpers::Encoder

data/lib/simple/sql/duplicate.rb

@@ -2,7 +2,11 @@
 
 module Simple
   module SQL
-    class Fragment < Struct.new(:to_sql)
+    unless defined?(Fragment)
+
+      class Fragment < Struct.new(:to_sql)
+      end
+
     end
 
     def fragment(str)

data/lib/simple/sql/helpers/immutable.rb

@@ -0,0 +1,150 @@
+module Simple
+  module SQL
+    module Helpers
+    end
+  end
+end
+
+class Simple::SQL::Helpers::Immutable
+  SELF = self
+
+  # turns an object, which can be a hash or array of hashes, arrays, and scalars
+  # into an object which you can use to access with dot methods.
+  def self.create(object, max_depth = 5)
+    case object
+    when Array
+      raise ArgumentError, "Object nested too deep (or inner loop?)" if max_depth < 0
+      object.map { |obj| create obj, max_depth - 1 }
+    when Hash
+      new(object)
+    else
+      object
+    end
+  end
+
+  private
+
+  def initialize(hsh)
+    @hsh = hsh
+  end
+
+  def method_missing(sym, *args, &block)
+    if args.empty? && !block
+      begin
+        value = @hsh.fetch(sym.to_sym) { @hsh.fetch(sym.to_s) }
+        return SELF.create(value)
+      rescue KeyError
+        # STDERR.puts "Missing attribute #{sym} for Immutable w/#{@hsh.inspect}"
+        nil
+      end
+    end
+
+    super
+  end
+
+  public
+
+  def respond_to_missing?(method_name, include_private = false)
+    @hsh.key?(method_name.to_sym) ||
+      @hsh.key?(method_name.to_s) ||
+      super
+  end
+
+  def inspect
+    "<Immutable: #{@hsh.inspect}>"
+  end
+
+  def respond_to?(sym)
+    super || @hsh.key?(sym.to_s) || @hsh.key?(sym.to_sym)
+  end
+
+  def ==(other)
+    @hsh == other
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+
+  require "test-unit"
+
+  class Simple::SQL::Helpers::Immutable::TestCase < Test::Unit::TestCase
+    Immutable = ::Simple::SQL::Helpers::Immutable
+
+    def hsh
+      {
+        a: "a-value",
+        "b": "b-value",
+        "child": {
+          name: "childname",
+          grandchild: {
+            name: "grandchildname"
+          }
+        },
+        "children": [
+          "anna",
+          "arthur",
+          {
+            action: {
+              keep_your_mouth_shut: true
+            }
+          }
+        ]
+      }
+    end
+
+    def immutable
+      Immutable.create hsh
+    end
+
+    def test_hash_access
+      assert_equal "a-value", immutable.a
+      assert_equal "b-value", immutable.b
+    end
+
+    def test_comparison
+      immutable = Immutable.create hsh
+
+      assert_equal immutable, hsh
+      assert_not_equal({}, immutable)
+    end
+
+    def test_child_access
+      child = immutable.child
+      assert_kind_of(Immutable, child)
+      assert_equal "childname", immutable.child.name
+      assert_equal "grandchildname", immutable.child.grandchild.name
+    end
+
+    def test_array_access
+      assert_kind_of(Array, immutable.children)
+      assert_equal 3, immutable.children.length
+      assert_equal "anna", immutable.children[0]
+
+      assert_kind_of(Immutable, immutable.children[2])
+      assert_equal true, immutable.children[2].action.keep_your_mouth_shut
+    end
+
+    def test_base_class
+      assert_nothing_raised do
+        immutable.object_id
+      end
+    end
+
+    def test_missing_keys
+      assert_raise(NoMethodError) do
+        immutable.foo
+      end
+    end
+
+    def test_skip_when_args_or_block
+      assert_raise(NoMethodError) do
+        immutable.a(1, 2, 3)
+      end
+      assert_raise(NoMethodError) do
+        immutable.a { :dummy }
+      end
+    end
+  end
+
+  # rubocop:enable Style/ClassAndModuleChildren
+end

data/lib/simple/sql/helpers/row_converter.rb

@@ -1,15 +1,21 @@
+require_relative "./immutable"
+
 module Simple::SQL::Helpers::RowConverter
   SELF = self
 
   # returns an array of converted records
-  def self.convert_row(records, into:, associations: nil)
+  def self.convert_row(records, into:, associations: nil, fq_table_name: nil)
     hsh = records.first
     return records unless hsh
 
     converter = if into == :struct
                   StructConverter.for(attributes: hsh.keys, associations: associations)
+                elsif into == :immutable
+                  ImmutableConverter.new(type: into, associations: associations)
+                elsif into.respond_to?(:new_from_row)
+                  TypeConverter2.new(type: into, associations: associations, fq_table_name: fq_table_name)
                 else
-                  TypeConverter.for(type: into, associations: associations)
+                  TypeConverter.new(type: into, associations: associations)
                 end
 
     records.map { |record| converter.convert_row(record) }
@@ -21,10 +27,6 @@ module Simple::SQL::Helpers::RowConverter
   end
 
   class TypeConverter #:nodoc:
-    def self.for(type:, associations:)
-      new(type: type, associations: associations)
-    end
-
     def initialize(type:, associations:)
       @type         = type
       @associations = associations
@@ -32,6 +34,10 @@ module Simple::SQL::Helpers::RowConverter
 
     def convert_row(hsh)
       hsh = convert_associations(hsh) if @associations
+      build_row_in_target_type hsh
+    end
+
+    def build_row_in_target_type(hsh)
       @type.new hsh
     end
 
@@ -50,6 +56,26 @@ module Simple::SQL::Helpers::RowConverter
     end
   end
 
+  class ImmutableConverter < TypeConverter #:nodoc:
+    Immutable = ::Simple::SQL::Helpers::Immutable
+
+    def build_row_in_target_type(hsh)
+      Immutable.create hsh
+    end
+  end
+
+  class TypeConverter2 < TypeConverter #:nodoc:
+    def initialize(type:, associations:, fq_table_name:)
+      super(type: type, associations: associations)
+      @fq_table_name = fq_table_name
+    end
+
+    def convert_row(hsh)
+      hsh = convert_associations(hsh) if @associations
+      @type.new_from_row hsh, fq_table_name: @fq_table_name
+    end
+  end
+
   class StructConverter # :nodoc:
     def self.for(attributes:, associations:)
       @cache ||= {}

data/lib/simple/sql/insert.rb

@@ -40,6 +40,8 @@ module Simple
       # - columns - name of columns, as Array[String] or Array[Symbol]
       #
       def initialize(table_name:, columns:, on_conflict:, into:)
+        raise ArgumentError, "Cannot insert a record without attributes" if columns.empty?
+
         @columns = columns
         @into = into
 
@@ -54,7 +56,7 @@ module Simple
         cols += timestamp_columns
         vals += timestamp_columns.map { "now()" }
 
-        returning = into ? '*' : "id"
+        returning = into ? "*" : "id"
 
         @sql = "INSERT INTO #{table_name} (#{cols.join(',')}) VALUES(#{vals.join(',')}) #{confict_handling(on_conflict)} RETURNING #{returning}"
       end

data/lib/simple/sql/reflection.rb

@@ -46,6 +46,13 @@ module Simple
       end
 
       def column_info(table_name)
+        @column_info ||= {}
+        @column_info[table_name] ||= _column_info(table_name)
+      end
+
+      private
+
+      def _column_info(table_name)
         schema, table_name = parse_table_name(table_name)
         recs = all <<~SQL, schema, table_name, into: Hash
           SELECT
@@ -58,8 +65,6 @@ module Simple
         records_by_attr(recs, :column_name)
       end
 
-      private
-
       def parse_table_name(table_name)
         p1, p2 = table_name.split(".", 2)
         if p2
@@ -75,6 +80,24 @@ module Simple
           hsh.update record[attr] => OpenStruct.new(record)
         end
       end
+
+      public
+
+      def lookup_pg_class(oid)
+        @pg_classes ||= {}
+        @pg_classes[oid] ||= _lookup_pg_class(oid)
+      end
+
+      private
+
+      def _lookup_pg_class(oid)
+        ::Simple::SQL.ask <<~SQL, oid
+          SELECT nspname AS schema, relname AS host_table
+          FROM pg_class
+          JOIN pg_namespace ON pg_namespace.oid=pg_class.relnamespace
+          WHERE pg_class.oid=$1
+        SQL
+      end
     end
   end
 end

data/lib/simple/sql/result/records.rb

@@ -1,8 +1,11 @@
 # xrubocop:disable Metrics/ParameterLists
 
 require_relative "association_loader"
+require "simple/sql/reflection"
 
 class ::Simple::SQL::Result::Records < ::Simple::SQL::Result
+  Reflection = ::Simple::SQL::Reflection
+
   def initialize(records, target_type:, pg_source_oid:) # :nodoc:
     expect! records.first => Hash unless records.empty?
 
@@ -45,12 +48,9 @@ class ::Simple::SQL::Result::Records < ::Simple::SQL::Result
     expect! as => [nil, Symbol]
 
     # resolve oid into table and schema name.
-    schema, host_table = ::Simple::SQL.ask <<~SQL, @pg_source_oid
-      SELECT nspname AS schema, relname AS host_table
-      FROM pg_class
-      JOIN pg_namespace ON pg_namespace.oid=pg_class.relnamespace
-      WHERE pg_class.oid=$1
-    SQL
+    #
+    # [TODO] is this still correct?
+    schema, host_table = Reflection.lookup_pg_class @pg_source_oid
 
     AssociationLoader.preload @hash_records, association,
                               host_table: host_table, schema: schema, as: as,
@@ -68,7 +68,12 @@ class ::Simple::SQL::Result::Records < ::Simple::SQL::Result
 
   def materialize
     records = @hash_records
-    records = RowConverter.convert_row(records, associations: @associations, into: @target_type) if @target_type != Hash
+    if @target_type != Hash
+      schema, host_table = Reflection.lookup_pg_class(@pg_source_oid)
+      records = RowConverter.convert_row(records, associations: @associations,
+                                                  into: @target_type,
+                                                  fq_table_name: "#{schema}.#{host_table}")
+    end
     replace(records)
   end
 end

data/lib/simple/sql/scope/filters.rb

@@ -1,4 +1,3 @@
-# rubocop:disable Style/IfUnlessModifier
 # rubocop:disable Style/GuardClause
 
 class Simple::SQL::Scope

data/lib/simple/sql/simple_transactions.rb

@@ -1,5 +1,3 @@
-# rubocop:disable Style/IfUnlessModifier
-
 # private
 module Simple::SQL::SimpleTransactions
   def tx_nesting_level

data/lib/simple/sql/version.rb

@@ -1,5 +1,5 @@
 module Simple
   module SQL
-    VERSION = "0.4.22"
+    VERSION = "0.4.23"
   end
 end

data/scripts/stats

@@ -0,0 +1,11 @@
+#!/bin/bash
+printf "=== $1\n"
+(
+  if [ -f $1.rb ]; then
+    cloc $(find $1/ -name *rb) $1.rb 
+  else
+    cloc $(find $1/ -name *rb) 
+  fi
+) |
+grep -E 'Language|Ruby' | sed 's-Language-        -'
+printf "\n"

data/spec/simple/sql_locked_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe "Simple::SQL.locked" do
+  xit 'acquires and releases an advisory lock' do # pending: "This code was manually tested"
+    one = Simple::SQL.locked(4711) do
+      Simple::SQL.ask "SELECT 1"
+    end
+
+    expect(one).to eq(1)
+  end
+
+  xit 'releases the lock after an exception' do # pending: "This code was manually tested"
+    begin
+      Simple::SQL.locked(4711) do
+        raise "HU"
+      end
+    rescue
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -21,7 +21,8 @@ end
 SQL = Simple::SQL
 USER_COUNT = 2
 
-ActiveRecord::Base.logger.level = Logger::INFO
+ActiveRecord::Base.logger.level = Logger::DEBUG
+Simple::SQL.logger.level = Logger::DEBUG
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
@@ -30,6 +31,10 @@ RSpec.configure do |config|
   config.order = "random"
   config.example_status_persistence_file_path = ".rspec.data"
 
+  config.backtrace_exclusion_patterns << /spec\/support/
+  config.backtrace_exclusion_patterns << /spec_helper/
+  config.backtrace_exclusion_patterns << /database_cleaner/
+
   config.around(:each) do |example|
     Simple::SQL.ask "TRUNCATE TABLE users, unique_users, organizations RESTART IDENTITY CASCADE"
     example.run

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-sql
 version: !ruby/object:Gem::Version
-  version: 0.4.22
+  version: 0.4.23
 platform: ruby
 authors:
 - radiospiel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-22 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_array_parser
@@ -175,10 +175,13 @@ files:
 - ".rubocop.yml"
 - ".tm_properties"
 - Gemfile
+- Makefile
 - README.md
 - Rakefile
 - bin/console
+- bin/pg
 - bin/rake
+- config/console-init.rb
 - config/database.yml
 - lib/simple-sql.rb
 - lib/simple/sql.rb
@@ -189,6 +192,7 @@ files:
 - lib/simple/sql/helpers.rb
 - lib/simple/sql/helpers/decoder.rb
 - lib/simple/sql/helpers/encoder.rb
+- lib/simple/sql/helpers/immutable.rb
 - lib/simple/sql/helpers/row_converter.rb
 - lib/simple/sql/insert.rb
 - lib/simple/sql/logging.rb
@@ -203,6 +207,7 @@ files:
 - lib/simple/sql/simple_transactions.rb
 - lib/simple/sql/version.rb
 - log/.gitkeep
+- scripts/stats
 - scripts/watch
 - simple-sql.gemspec
 - spec/manual/threadtest.rb
@@ -217,6 +222,7 @@ files:
 - spec/simple/sql/reflection_spec.rb
 - spec/simple/sql/scope_spec.rb
 - spec/simple/sql/version_spec.rb
+- spec/simple/sql_locked_spec.rb
 - spec/spec_helper.rb
 - spec/support/001_database.rb
 - spec/support/002_database_cleaner.rb
@@ -260,6 +266,7 @@ test_files:
 - spec/simple/sql/reflection_spec.rb
 - spec/simple/sql/scope_spec.rb
 - spec/simple/sql/version_spec.rb
+- spec/simple/sql_locked_spec.rb
 - spec/spec_helper.rb
 - spec/support/001_database.rb
 - spec/support/002_database_cleaner.rb