activerecord-lookml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a07c3476ccf7972ccb3d63e9980b9bcc80b946948bb916747394fe07cff35a4
+  data.tar.gz: 90e41c624eedc09d131db0710d55528d6380c6dffa55d7e7c0ce3587cc0f5e36
+SHA512:
+  metadata.gz: f4a5fa4bdc77dfdd52f36da8b24b0ffe30a12667c5c49483e24eaf5e38003835dd2302d7e2916ebd2def73da9e310438b47c7e5cc46165a613441066d6fa27f6
+  data.tar.gz: 0af9abfbccd4c6cb0507dda2a1f42d6d788f3c4249e685ff90bc73b7dc66c3b3897ab9668b89fcb12b25455397abffb73916357f169c10b6d924b2ac17c4e160

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

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 yoshi@wantedly.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activerecord-lookml.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Yoshinori Kawasaki
+
+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,88 @@
+# ActiveRecord::LookML
+
+This gem is ActiveRecord extension for LookML (Looker).
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'activerecord-lookml', git: 'git@github.com:wantedly/activerecord-looker.git'
+end
+```
+
+## Usage
+
+### ActiveRecord::Enum
+
+Suppose you have ActiveRecord class with enum as below.
+
+```ruby
+class PulseOnboardingStatus < ApplicationRecord
+  MEMBER_TUTORIAL_STATE_ENUM_HASH = {
+    explain_condition_survay: 0,
+    ask_condition: 1,
+    explain_high_fives: 2,
+    try_high_fives: 3,
+    done_tutorial: 4,
+  }.freeze
+
+  enum member_tutorial_state: MEMBER_TUTORIAL_STATE_ENUM_HASH, _prefix: true
+end
+```
+
+You can generate LookML dimension as below.
+
+```
+$ ./bin/rails c
+
+> puts PulseOnboardingStatus.enum_to_lookml
+
+  dimension: member_tutorial_state {
+    case: {
+        when: {
+        sql: ${TABLE}.member_tutorial_state = 0 ;;
+        label: "explain_condition_survay"
+      }
+      when: {
+        sql: ${TABLE}.member_tutorial_state = 1 ;;
+        label: "ask_condition"
+      }
+      when: {
+        sql: ${TABLE}.member_tutorial_state = 2 ;;
+        label: "explain_high_fives"
+      }
+      when: {
+        sql: ${TABLE}.member_tutorial_state = 3 ;;
+        label: "try_high_fives"
+      }
+      when: {
+        sql: ${TABLE}.member_tutorial_state = 4 ;;
+        label: "done_tutorial"
+      }
+
+    }
+  }
+```
+
+## 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/wantedly/activerecord-lookml. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/wantedly/activerecord-lookml/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Activerecord::Lookml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wantedly/activerecord-lookml/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/activerecord-lookml.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/activerecord/lookml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-lookml"
+  spec.version       = ActiveRecord::LookML::VERSION
+  spec.authors       = ["Yoshinori Kawasaki"]
+  spec.email         = ["yoshi@wantedly.com"]
+
+  spec.summary       = %q{ActiveRecord extension for LookML (Looker)}
+  spec.description   = %q{[Experimental] Generate LookML}
+  spec.homepage      = "https://github.com/wantedly/activerecord-lookml"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/wantedly/activerecord-lookml"
+  spec.metadata["changelog_uri"] = "https://github.com/wantedly/activerecord-lookml/blob/master/CHANGELOG.md"
+
+  # 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 'activesupport', '>= 6'
+  spec.add_dependency 'activerecord', '>= 6'
+
+  spec.add_development_dependency 'activerecord', '>= 6'
+end

data/bin/console

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

@@ -0,0 +1,14 @@
+require 'active_support/all'
+require "activerecord/lookml/version"
+
+module ActiveRecord
+  module LookML
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  require 'activerecord/lookml/core'
+  ::ActiveRecord::Base.send :include, ActiveRecord::LookML::Core
+end

data/lib/activerecord/lookml/core.rb

@@ -0,0 +1,84 @@
+module ActiveRecord
+  module LookML
+    module Core
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Generates LookML dimension from ruby hash.
+        #
+        # Input format:
+        #
+        # {"manager_tutorial_state"=>
+        #   {"start_tutorial"=>0,
+        #    "explain_condition_survay"=>1,
+        #    "ask_condition"=>2,
+        #    "explain_high_fives"=>3,
+        #    "try_high_fives"=>4,
+        #    "request_members_to_get_started"=>5,
+        #    "done_announce_to_member"=>6,
+        #    "done_tutorial"=>7}}
+        #
+        #
+        # Output format:
+        #
+        # dimension: manager_tutorial_state {
+        #   case: {
+        #       when: {
+        #       sql: ${TABLE}.manager_tutorial_state = 0 ;;
+        #       label: "start_tutorial"
+        #     }
+        #     when: {
+        #       sql: ${TABLE}.manager_tutorial_state = 1 ;;
+        #       label: "explain_condition_survay"
+        #     }
+        #     when: {
+        #       sql: ${TABLE}.manager_tutorial_state = 2 ;;
+        #       label: "ask_condition"
+        #     }
+        #     when: {
+        #       sql: ${TABLE}.manager_tutorial_state = 3 ;;
+        #       label: "explain_high_fives"
+        #     }
+        #     when: {
+        #       sql: ${TABLE}.manager_tutorial_state = 4 ;;
+        #       label: "try_high_fives"
+        #     }
+        #     when: {
+        #       sql: ${TABLE}.manager_tutorial_state = 5 ;;
+        #       label: "request_members_to_get_started"
+        #     }
+        #     when: {
+        #       sql: ${TABLE}.manager_tutorial_state = 6 ;;
+        #       label: "done_announce_to_member"
+        #     }
+        #     when: {
+        #       sql: ${TABLE}.manager_tutorial_state = 7 ;;
+        #       label: "done_tutorial"
+        #     }
+        #   }
+        # }
+        # @see https://github.com/rails/rails/blob/master/activerecord/lib/active_record/enum.rb
+        def enum_to_lookml
+          defined_enums.map do |name, enum_values|
+            when_lines_lookml = enum_values.map do |label, value|
+              <<-LOOKML
+      when: {
+        sql: ${TABLE}.#{name} = #{value} ;;
+        label: "#{label}"
+      }
+              LOOKML
+            end.join
+
+            <<-LOOKML
+  dimension: #{name} {
+    case: {
+  #{when_lines_lookml}
+    }
+  }
+            LOOKML
+          end.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/lookml/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module LookML
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-lookml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshinori Kawasaki
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+description: "[Experimental] Generate LookML"
+email:
+- yoshi@wantedly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-lookml.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord/lookml.rb
+- lib/activerecord/lookml/core.rb
+- lib/activerecord/lookml/version.rb
+homepage: https://github.com/wantedly/activerecord-lookml
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wantedly/activerecord-lookml
+  source_code_uri: https://github.com/wantedly/activerecord-lookml
+  changelog_uri: https://github.com/wantedly/activerecord-lookml/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: ActiveRecord extension for LookML (Looker)
+test_files: []