archon 0.0.1 → 0.0.3

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at weare@icalialabs.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in archon.gemspec
+gemspec
+
+gem 'gem-release', '~> 0.7.4'
+
+# Run specs automatically:
+gem 'guard-rspec', '~> 4.7', '>= 4.7.3', require: false

data/README.md

@@ -2,9 +2,8 @@
 
 ARchon: Summoning the powers of ActiveRecord and ARel to wreak havoc
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/archon`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Archon is a collection of Arel nodes, shortcut methods and ActiveRecord model methods that make
+doing complicated database queries & stuff simpler and right.
 
 ## Installation
 
@@ -34,7 +33,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/archon. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/IcaliaLabs/archon. 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

data/Rakefile

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

data/archon.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'archon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "archon"
+  spec.version       = Archon::VERSION
+  spec.authors       = ["Roberto Quintanilla"]
+  spec.email         = ["vov@icalialabs.com"]
+
+  spec.summary       = %q{ARchon: Summoning the powers of ActiveRecord and ARel to wreak havoc}
+  spec.description   = %q{A collection of methods and classes that unleash the power of the database :D}
+  spec.homepage      = "https://github.com/IcaliaLabs/archon-gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  all_things_rails_version_string = ['>= 4.2']
+  spec.add_runtime_dependency %q<activerecord>, all_things_rails_version_string
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

data/bin/console

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

@@ -0,0 +1,11 @@
+# 1: Use ruby 2.3.3 as base:
+FROM ruby:2.3.3
+
+# 2: We'll set this gem path as the working directory
+WORKDIR /usr/src/lib
+
+# 3: We'll set the working dir as HOME and add the app's binaries path to $PATH:
+ENV HOME=/usr/src/lib PATH=/usr/src/lib/bin:$PATH
+
+# 4: Set the default command:
+CMD ["guard"]

data/docker-compose.yml

@@ -0,0 +1,29 @@
+version: '2.1'
+
+volumes:
+  archon-gems:
+    driver: local
+
+services:
+
+  lib:
+    build:
+      context: .
+      dockerfile: dev.Dockerfile
+    image: icalialabs/archon-gem:development
+
+    volumes:
+      # Mount our app code directory (".") into our app containers at the `/usr/src/lib` folder:
+      - .:/usr/src/lib
+      # Mount the 'archon-gems' volume on the folder that stores bundled gems:
+      - archon-gems:/usr/local/bundle
+
+    # Keep the stdin open, so we can attach to our app container's process
+    # and do things such as byebug, etc:
+    stdin_open: true
+
+    # Enable sending signals (CTRL+C, CTRL+P + CTRL+Q) into the container:
+    tty: true
+
+    # The command:
+    command: guard

data/lib/archon.rb

@@ -0,0 +1,25 @@
+require "archon/version"
+
+# = Archon
+#
+# Archon is a collection of Arel nodes, shortcut methods and ActiveRecord model methods that make
+# doing complicated stuff relatively simpler.
+module Archon
+  extend ActiveSupport::Autoload
+
+  autoload :Nodes
+  autoload :InsertIntoSelect
+  autoload :PowerOverwhelming
+
+  def self.method_missing(called_method_name, *arguments, &block)
+    # Call super to raise a method missing error if no class was loaded:
+    called_method_name_as_constant = called_method_name.to_s.camelize
+    super unless [
+      "Archon::Nodes::#{called_method_name_as_constant}".safe_constantize,
+      "Archon::#{called_method_name_as_constant}".safe_constantize
+    ].compact!.any?
+
+    # Try again, this time we expect the loaded module added the method to Archon:
+    send called_method_name, *arguments, &block
+  end
+end

data/lib/archon/insert_into_select.rb

@@ -0,0 +1,41 @@
+# = Archon.insert_into_select
+module Archon
+  def self.insert_into_select(insertion_table, selection, options = {})
+    return InsertIntoSelect.new insertion_table, selection, options
+  end
+
+  # = InsertIntoSelect
+  #
+  # Extends an ARel InsertManager that will generate an `INSERT INTO (...) SELECT` query, which will
+  # insert data into the given table from the given selection - either an ARel SelectManager-ish, or
+  # an ActiveRecord::Relation.
+  #
+  # It will try to determine the columns that will be inserted from the projections specified in the
+  # given selection.
+  class InsertIntoSelect < Arel::InsertManager
+    attr_reader :projections
+    def initialize(tableish, selectish, options = {})
+      super()
+      self.into tableish.respond_to?(:arel_table) ? tableish.arel_table : tableish
+      self.select selectish.respond_to?(:arel) ? selectish.arel : selectish
+
+      # Fetch the insert columns from the options - default to the select column names interpolated
+      # into the inserted table:
+      self.columns.concat options.fetch(
+        :columns,
+        ast.select.projections.map do |projection|
+          column_name = if projection.is_a? Arel::Attributes::Attribute
+                          projection.name
+                        elsif projection.is_a? Arel::Nodes::As
+                          projection.right.delete('"').to_sym
+                        elsif projection.is_a? Arel::Nodes::NamedFunction
+                          projection.alias.delete('"').to_sym
+                        else
+                          raise "Don't know how to..."
+                        end
+          ast.relation[column_name]
+        end
+      )
+    end
+  end
+end

data/lib/archon/nodes.rb

@@ -0,0 +1,10 @@
+module Archon
+  # = Nodes
+  # A collection of ARel nodes that do powerful stuff
+  module Nodes
+    extend ActiveSupport::Autoload
+
+    autoload :Coalesce
+    autoload :PopulatedRecordset
+  end
+end

data/lib/archon/nodes/coalesce.rb

@@ -0,0 +1,17 @@
+# = Archon.coalesce
+module Archon
+  def self.coalesce(*coalescees)
+    return Nodes::Coalesce.new(*coalescees)
+  end
+
+  module Nodes
+    # = Coalesce
+    #
+    # An Arel node that generates a 'COALESCE' statement
+    class Coalesce < Arel::Nodes::NamedFunction
+      def initialize(*coalescees)
+        super 'COALESCE', coalescees
+      end
+    end
+  end
+end

data/lib/archon/nodes/populated_recordset.rb

@@ -0,0 +1,30 @@
+# = Archon.populated_recordset
+module Archon
+  def self.populated_recordset(base, rows = [])
+    return Nodes::PopulatedRecordset.new base, rows
+  end
+
+  module Nodes
+    # = PopulatedRecordset
+    #
+    # This ARel node creates a populated recordset from a JSON generated by the given ruby array of
+    # hashes.
+    class PopulatedRecordset < Arel::Nodes::NamedFunction
+      def initialize(base, rows = [])
+        raise ArgumentError, "rows is not an array" unless rows.is_a? Array
+        super 'json_populate_recordset', [
+          Arel::Nodes::SqlLiteral.new(base),
+          Arel::Nodes::Quoted.new(ActiveSupport::JSON.encode(rows))
+        ]
+      end
+
+      def aliased_as(recordset_alias)
+        Arel::Nodes::TableAlias.new(self, recordset_alias)
+      end
+
+      def selectable
+        Arel::SelectManager.new self
+      end
+    end
+  end
+end

data/lib/archon/power_overwhelming.rb

@@ -0,0 +1,34 @@
+module Archon
+  # = PowerOverwhelming
+  #
+  # Packs several powerful convenient methods for ActiveRecord models. You can add them like this:
+  #
+  # == ActiveRecord >= 5.x
+  #  ```
+  #  # app/models/application_record.rb
+  #  class ApplicationRecord < ActiveRecord::Base
+  #    self.abstract_class = true
+  #    include Archon::PowerOverwhelming
+  #  end
+  # ```
+  #
+  # == ActiveRecord >= 4.2.x, < 5.x
+  #  ```
+  #  # initializers/archon.rb
+  #  ActiveRecord::Base.send :include, Archon::PowerOverwhelming
+  #  ```
+  module PowerOverwhelming
+    extend ActiveSupport::Concern
+
+    # = Archon::PowerOverwhelming::ClassMethods
+    # Some methods applied to model classes and ActiveRecord::Relation objects
+    module ClassMethods
+      def create_from(selectish)
+        transaction do
+          timestamp = ActiveRecord::Base.connection.quoted_date(Time.now)
+          timestamp = Arel::Nodes::SqlLiteral.new("'#{timestamp}'")
+        end
+      end
+    end
+  end
+end

data/lib/archon/version.rb

@@ -0,0 +1,3 @@
+module Archon
+  VERSION = "0.0.3"
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: archon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Roberto Quintanilla
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2016-12-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -60,9 +74,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
 - LICENSE
 - README.md
+- Rakefile
+- archon.gemspec
+- bin/console
+- bin/setup
+- dev.Dockerfile
+- docker-compose.yml
+- lib/archon.rb
+- lib/archon/insert_into_select.rb
+- lib/archon/nodes.rb
+- lib/archon/nodes/coalesce.rb
+- lib/archon/nodes/populated_recordset.rb
+- lib/archon/power_overwhelming.rb
+- lib/archon/version.rb
 homepage: https://github.com/IcaliaLabs/archon-gem
 licenses:
 - MIT