mappd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 473cb92d742f731112c8443bacddf1e2dc92592940133fa9eaaa7de99a7754ca
+  data.tar.gz: c995d4dbef38bae61681a966c6ffacf057f5f09705d497bbb97423e6881e63a2
+SHA512:
+  metadata.gz: c2abed12e72d3894bb419fd10f814426d4d029c6d2e28ef78dfad2ce2ab6d267865cd3b3dc31e57ac6e3291bf87df61b7c725d35dbc05600ccde96a23376acb3
+  data.tar.gz: 5e6dec9fbafabb3fab482cc5a856289718625acac1022c9bdad9aaa9658b9314a034c6623e2c6870d13ca758ee7d2ff8f4ec3f6280415cbbe93bd9e3bba90076

data/.gitignore

@@ -0,0 +1,2 @@
+tmp/
+.byebug_history

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+      - 'Guardfile'
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"

data/Dockerfile

@@ -0,0 +1,31 @@
+FROM ruby:2.5-slim
+MAINTAINER dan@paz.am
+ENV REFRESHED_AT 2018-05-14
+
+# Install packages
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential \
+    git \
+    ruby-dev \
+    libgdbm-dev \
+    libncurses5-dev \
+    libffi-dev \
+    libyaml-dev \
+    libreadline-dev \
+    sqlite3 \
+    libsqlite3-dev \
+    curl \
+    libpq-dev \
+    default-libmysqlclient-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+# Setup app location
+RUN mkdir -p /app
+WORKDIR /app
+
+# Install gems
+ADD mappd.gemspec /app/mappd.gemspec
+ADD Gemfile /app/Gemfile
+ADD Gemfile.lock /app/Gemfile.lock
+ADD lib/ /app/lib
+RUN bundle install --jobs 4

data/Gemfile

@@ -0,0 +1,19 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '>= 5.2.0'
+gem 'rake'
+gem 'sqlite3'
+
+group :development do
+  gem 'byebug'
+  gem 'guard-rspec', require: false
+  gem 'guard-rubocop', require: false
+  gem 'rubocop', require: false
+end
+
+group :test do
+  gem 'rspec'
+  gem 'shoulda-matchers'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,119 @@
+PATH
+  remote: .
+  specs:
+    mappd (0.0.1.beta)
+      activerecord (>= 5.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    ffi (1.9.23)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    shoulda-matchers (3.1.2)
+      activesupport (>= 4.0.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 5.2.0)
+  byebug
+  guard-rspec
+  guard-rubocop
+  mappd!
+  rake
+  rspec
+  rubocop
+  shoulda-matchers
+  sqlite3
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,10 @@
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/Makefile

@@ -0,0 +1,10 @@
+build:
+	docker-compose build
+guard:
+	docker-compose run ruby guard
+rspec:
+	docker-compose run ruby rspec
+lint:
+	docker-compose run ruby rubocop
+release:
+

data/README.md

@@ -0,0 +1,88 @@
+# README
+
+Mappd is a replacement gem for [mini_record](https://github.com/DAddYE/mini_record). Mini record is great and I have been using it for a number of years. Unfortunately the mini_record report has not been updated in some time. With recent rails upgrades mini_record is not working well.
+
+Mappd is designed to work with ActiveRecord 5.2 >.
+
+It's simple to use.
+
+```ruby
+class Person < ActiveRecord::Base
+  field :name, :string, null: false, default: ''
+  field :age, :integer
+  field :score, :decimal, precision: 10, scale: 10, null: true
+
+  # Rename a field - the old field and rename could be removed after
+  # migrate! is called
+  field :external_id, :string, length: 10
+  rename :external_id, :e_id
+  field :e_id, :string, length: 10
+
+  # Hooks into belongs_to and creates a country_id column
+  # with an index
+  belongs_to :country
+  
+  # Creates a join table people_roles
+  has_and_belongs_to_many :roles
+
+  # Creates an index
+  index :e_id
+
+  # Creates created_at and updated_at columns
+  timestamps
+end
+
+class Country < ActiveRecord::Base
+  field :name, :string
+end
+
+class Role < ActiveRecord::Base
+  field :name
+  has_and_belongs_to_many :people
+end
+
+Person.migrate!
+Country.migrate!
+Role.migrate!
+```
+
+Hey presto your database has been created with the correct schema.
+
+# Types & Options - Field
+
+```field :name, :type, options = {}```
+
+The type parameter is normally one of the migrations native types, which is one of the following: 
+
+```:primary_key``` 
+```:string```
+```:text```
+```:integer```
+```:bigint```
+```:float```
+```:decimal```
+```:numeric```
+```:datetime```
+```:time```
+```:date```
+```:binary```
+```:boolean```
+
+You may use a type not in this list as long as it is supported by your database (for example, “polygon” in MySQL), but this will not be database agnostic and should usually be avoided.
+
+Available options are (none of these exists by default):
+
+```:limit``` - Requests a maximum column length. This is the number of characters for a :string column and number of bytes for :text, :binary and :integer columns. This option is ignored by some backends.
+
+```:default``` - The column's default value. Use nil for NULL.
+
+```:null``` - Allows or disallows NULL values in the column.
+
+```:precision``` - Specifies the precision for the :decimal and :numeric columns.
+
+```:scale``` - Specifies the scale for the :decimal and :numeric columns.
+
+```:comment``` - Specifies the comment for the column. This option is ignored by some backends.
+
+
+

data/docker-compose.yml

@@ -0,0 +1,9 @@
+version: '2'
+services:
+  ruby:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - .:/app
+    command: ''

data/lib/mappd.rb

@@ -0,0 +1,5 @@
+require 'rubygems' unless defined?(Gem)
+require 'active_record'
+require 'mappd/mappd'
+
+ActiveRecord::Base.send(:include, Mappd)

data/lib/mappd/mappd.rb

@@ -0,0 +1,80 @@
+module Mappd
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def index(name, options = {})
+      commands << [:add_index, [table_name, name, options]]
+    end
+
+    def rename(from, to)
+      commands << [:rename_column, [table_name, from, to]]
+    end
+
+    def field(name, type = :string, options = {})
+      commands << [:add_column, [table_name, name, type, options]]
+    end
+
+    def timestamps
+      commands << [:add_timestamps, [table_name, null: true]]
+    end
+
+    def associations!
+      reflect_on_all_associations.each do |association|
+        case association.macro
+        when :belongs_to
+          commands << [:add_reference, [table_name, association.name, {}]]
+        when :has_and_belongs_to_many
+          commands << [:create_join_table,
+                       [table_name.to_sym, association.name]]
+        end
+      end
+    end
+
+    def migrate!
+      create_table!
+      associations!
+      execute_commands!
+    end
+
+    def commands
+      @commands ||= []
+    end
+
+    private
+
+    def create_table!
+      connection.create_table(table_name) unless
+      connection.table_exists?(table_name)
+    end
+
+    def execute_commands!
+      commands.each do |command|
+        if column_exists?(command)
+          connection.send(:change_column, *command[1])
+        else
+          connection.send(command[0], *command[1])
+        end
+      rescue ActiveRecord::StatementInvalid => e
+        warn(e)
+      end
+      reset!
+    end
+
+    def reset!
+      reset_column_information
+      @commands = []
+    end
+
+    def column_exists?(command)
+      command[0] == :add_column &&
+        connection.column_exists?(table_name, command[1][1])
+    end
+
+    def warn(message)
+      @logger ||= Logger.new(nil)
+      @logger.warn(message)
+    end
+  end
+end

data/lib/mappd/version.rb

@@ -0,0 +1,3 @@
+module Mappd
+  VERSION = '0.0.1'.freeze
+end

data/mappd.gemspec

@@ -0,0 +1,29 @@
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'mappd/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'mappd'
+  s.version     = Mappd::VERSION
+  s.authors     = ['Dan Watson']
+  s.email       = ['dan@paz.am']
+  s.homepage    = 'https://github.com/dan-watson/mappd'
+  s.summary     = 'Mappd is a micro gem that allow you to write schema
+  inside your model as you can do in DataMapper.'
+  s.description = 'With it you can add the ability to create columns
+outside the default schema, directly in your model in a similar way t
+at you just know in others projects like  DataMapper or MongoMapper.
+  '.gsub(/^ {4}/, '')
+
+  s.rubyforge_project = 'mappd'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`
+                    .split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_dependency 'activerecord', '>=5.2.0'
+end

data/spec/boot.rb

@@ -0,0 +1,6 @@
+require 'rubygems' unless defined?(Gem)
+require 'bundler/setup'
+require 'mappd'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3',
+                                        database: ':memory:')

data/spec/mappd_spec.rb

@@ -0,0 +1,39 @@
+require 'byebug'
+require File.expand_path('boot.rb', __dir__)
+require File.expand_path('spec_helper.rb', __dir__)
+require File.expand_path('models.rb', __dir__)
+
+context '#create table' do
+  it 'is nil when a table already exists' do
+    expect(Person.send(:create_table!)).to be_nil
+  end
+end
+
+RSpec.describe Person, type: :model do
+  it { should have_db_column(:name).of_type(:string) }
+  it { should have_db_column(:age).of_type(:integer) }
+  it {
+    should have_db_column(:score).of_type(:decimal)
+                                 .with_options(precision: 10,
+                                               scale: 10,
+                                               null: true)
+  }
+  it { should_not have_db_column(:external_id) }
+  it {
+    should have_db_column(:e_id).of_type(:string)
+                                .with_options(length: 10)
+  }
+
+  it { should have_db_column(:country_id).of_type(:integer) }
+  it { should have_db_index(:country_id) }
+  it { should have_db_index(:e_id) }
+
+  context '#change column' do
+    before(:all) do
+      Person.field(:age, :string)
+      Person.migrate!
+    end
+
+    it { should have_db_column(:age).of_type(:string) }
+  end
+end

data/spec/models.rb

@@ -0,0 +1,31 @@
+require 'active_record'
+
+class Person < ActiveRecord::Base
+  field :name, :string, null: false, default: ''
+  field :age, :integer
+  field :score, :decimal, precision: 10, scale: 10, null: true
+
+  field :external_id, :string, length: 10
+  rename :external_id, :e_id
+  field :e_id, :string, length: 10
+
+  belongs_to :country
+  has_and_belongs_to_many :roles
+
+  index :e_id
+
+  timestamps
+end
+
+class Country < ActiveRecord::Base
+  field :name, :string
+end
+
+class Role < ActiveRecord::Base
+  field :name
+  has_and_belongs_to_many :people
+end
+
+Person.migrate!
+Country.migrate!
+Role.migrate!

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'shoulda-matchers'
+require File.expand_path('boot.rb', __dir__)
+require File.expand_path('models.rb', __dir__)
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :active_record
+    with.library :active_model
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: mappd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Watson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+description: "With it you can add the ability to create columns\noutside the default
+  schema, directly in your model in a similar way t\nat you just know in others projects
+  like  DataMapper or MongoMapper.\n  "
+email:
+- dan@paz.am
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- Makefile
+- README.md
+- docker-compose.yml
+- lib/mappd.rb
+- lib/mappd/mappd.rb
+- lib/mappd/version.rb
+- mappd.gemspec
+- spec/boot.rb
+- spec/mappd_spec.rb
+- spec/models.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dan-watson/mappd
+licenses: []
+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: mappd
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Mappd is a micro gem that allow you to write schema inside your model as
+  you can do in DataMapper.
+test_files: []