activerecord-lookml 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51994f9cd3d936cd0d7df51d8ba8a9a0bf99aad22f03405fb9fc975d35263a11
-  data.tar.gz: 1e239e2f8f1474e2e340ac16df097dd6a78d6a500ab9614eae93990413e6fd80
+  metadata.gz: 22e877c5df61744d96c9ae907254ffbb3b41c7ef05a950784a79314be5ed88d5
+  data.tar.gz: 5db79293a902a2a9aef8679b7f339fe28a3bf2b4f052428d46ac7b35450e07da
 SHA512:
-  metadata.gz: dc3a73dfb0cbe15db67b7a025c6591bd3a92e6b98b671755e3ae4a09d396ddb45453f697d7edf7276ec8845c10c9d2e14f8b2f7c259cdeec4325c40d0701d2ef
-  data.tar.gz: 5c16904267407519928811f499c69f86dc62af8d0ecbc9415c874938a7787f9cfb46984be2ad8e47a479d69bee3b815d082af7bf13ad0962179d4a961a47fc43
+  metadata.gz: 55c559b73d85f62c9ce2a641d6fdc17cf99ba87b4c761789a56ebc32ca0f362b450beb27960483c425c895e0f7fea99fe2be6f0bb9e0e406942277dd7910dd40
+  data.tar.gz: 6e849f35450be8afb6e7d007917ca6169e8f12f6c0c4051daeba5a1e4610c5f4ef484d4f0b6e9f7e44fc874c7bc9855426dda7f91cae44c519352475a62a8724

data/CHANGELOG.md

@@ -1,8 +1,13 @@
 ## Unreleased
 
+## 0.3.0
+
+- Fature: Support String column.
+- Internal change for LookML string generation.
+
 ## 0.2.1
 
-Bug fixes and minor improvements.
+Bug fixes and minor improvements only.
 
 ## 0.2.0
 

data/README.md

@@ -16,14 +16,27 @@ end
 
 ## Usage
 
-### ActiveRecord::Enum
+### Generate LookML view from ActiveRecord class
 
-Suppose you have ActiveRecord class with enum as below.
+Suppose you have ActiveRecord class as below:
 
 ```ruby
-class PulseOnboardingStatus < ApplicationRecord
+ActiveRecord::Schema.define(version: 2021_05_26_103300) do
+  create_table "pulse_onboarding_statuses", force: :cascade do |t|
+    t.bigint "user_id", null: false
+    t.bigint "company_id", null: false
+    t.integer "member_tutorial_state"
+    t.boolean "completed", default: false, null: false
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+  end
+end
+```
+
+```ruby
+class PulseOnboardingStatus < ActiveRecord::Base
   MEMBER_TUTORIAL_STATE_ENUM_HASH = {
-    explain_condition_survay: 0,
+    explain_condition_survey: 0,
     ask_condition: 1,
     explain_high_fives: 2,
     try_high_fives: 3,
@@ -37,15 +50,31 @@ end
 You can generate LookML dimension as below.
 
 ```
-$ ./bin/rails c
+> puts PulseOnboardingStatus.to_lookml
+view: pulse_onboarding_statuses {
+  sql_table_name: `wantedly-1371.rdb.pulse_pulse_onboarding_statuses`;;
+
+  dimension: id {
+    type: number
+    primary_key: yes
+    sql: ${TABLE}.id ;;
+  }
 
-> puts PulseOnboardingStatus.enum_to_lookml
+  dimension: user_id {
+    type: number
+    sql: ${TABLE}.user_id ;;
+  }
+
+  dimension: company_id {
+    type: number
+    sql: ${TABLE}.company_id ;;
+  }
 
   dimension: member_tutorial_state {
     case: {
-        when: {
+      when: {
         sql: ${TABLE}.member_tutorial_state = 0 ;;
-        label: "explain_condition_survay"
+        label: "explain_condition_survey"
       }
       when: {
         sql: ${TABLE}.member_tutorial_state = 1 ;;
@@ -66,6 +95,34 @@ $ ./bin/rails c
 
     }
   }
+
+  dimension: completed {
+    type: yesno
+    sql: ${TABLE}.completed ;;
+  }
+
+  dimension_group: created_at {
+    type: time
+    sql: ${TABLE}.created_at ;;
+  }
+
+  dimension_group: updated_at {
+    type: time
+    sql: ${TABLE}.updated_at ;;
+  }
+
+  set: detail {
+    fields: [
+      id,
+      user_id,
+      company_id,
+      member_tutorial_state,
+      completed,
+      created_at_time,
+      updated_at_time
+    ]
+  }
+}
 ```
 
 ## Development

data/lib/active_record/lookml.rb

@@ -1,5 +1,8 @@
 require 'active_support/all'
-require "active_record/lookml/version"
+require 'active_record/lookml/version'
+require 'active_record/lookml/block'
+require 'active_record/lookml/field'
+require 'active_record/lookml/array_field'
 
 module ActiveRecord
   module LookML

data/lib/active_record/lookml/array_field.rb

@@ -0,0 +1,21 @@
+module ActiveRecord
+  module LookML
+    class ArrayField
+      def initialize(name:, values:)
+        @name = name
+        @values = values
+      end
+
+      def to_lookml(indent_level: 0)
+        indent = '  ' * indent_level
+        lookml = "#{indent}#{@name}: [\n"
+        lookml << @values.map do |value|
+          "#{indent}  #{value}"
+        end.join(",\n")
+        lookml << "\n"
+        lookml << "#{indent}]\n"
+        lookml
+      end
+    end
+  end
+end

data/lib/active_record/lookml/block.rb

@@ -0,0 +1,29 @@
+module ActiveRecord
+  module LookML
+    class Block
+      def initialize(type:, name:)
+        @type = type
+        @name = name
+        @fields = []
+        yield(self) if block_given?
+      end
+
+      def <<(new_field)
+        @fields << new_field
+      end
+
+      def to_lookml(indent_level: 0)
+        indent = '  ' * indent_level
+        lookml = "#{indent}#{@type}:"
+        lookml << " #{@name}" if @name
+        lookml << " {\n"
+        @fields.each_with_index do |field, index|
+          lookml << "\n" if index > 0 && field.is_a?(Block)
+          lookml << field.to_lookml(indent_level: indent_level + 1)
+        end
+        lookml << "#{indent}}\n"
+        lookml
+      end
+    end
+  end
+end

data/lib/active_record/lookml/core.rb

@@ -4,157 +4,62 @@ module ActiveRecord
       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
-
         def to_lookml(table_name_prefix: 'wantedly-1371.rdb.pulse_')
-          dimensions_lookml = attribute_types.map do |attribute, type|
-            attribute_type_to_dimension_lookml(attribute, type)
-          end.join("\n")
-
           fields = attribute_types.map do |attribute, type|
             attribute_type_to_set_detail_field(attribute, type)
           end.compact
-          fields_lookml = fields.map { |field| "      #{field}" }.join(",\n")
 
-          set_lookml = <<-LOOKML
-  set: detail {
-    fields: [
-#{fields_lookml}
-    ]
-  }
-          LOOKML
-
-          <<-LOOKML
-view: pulse_onboarding_statuses {
-  sql_table_name: `#{table_name_prefix}#{table_name}`;;
+          set_block = Block.new(type: "set", name: "detail") do |b|
+            b << ArrayField.new(name: "fields", values: fields)
+          end
 
-#{dimensions_lookml}
-#{set_lookml}}
-          LOOKML
+          Block.new(type: "view", name: "pulse_onboarding_statuses") do |b|
+            b << Field.new(name: "sql_table_name", value: "`#{table_name_prefix}#{table_name}`;;")
+            attribute_types.each do |attribute, type|
+              b << attribute_type_to_block(attribute, type)
+            end
+            b << set_block
+          end.to_lookml
         end
 
         private
-        def attribute_type_to_dimension_lookml(attribute, type)
+        def attribute_type_to_block(attribute, type)
           case type
           when ActiveModel::Type::Integer
-            params = {
-              type: "number",
-              primary_key: attribute == "id" ? "yes" : nil,
-              sql: "${TABLE}.#{attribute} ;;"
-            }.compact
-
-            params_lookml = params.map { |k, v| "    #{k}: #{v}" }.join("\n")
-
-            <<-LOOKML
-  dimension: #{attribute} {
-#{params_lookml}
-  }
-            LOOKML
+            Block.new(type: "dimension", name: attribute) do |b|
+              b << Field.new(name: "type", value: "number")
+              b << Field.new(name: "primary_key", value: "yes") if attribute == "id"
+              b << Field.new(name: "sql", value: "${TABLE}.#{attribute} ;;")
+            end
           when ActiveModel::Type::Boolean
-            <<-LOOKML
-  dimension: #{attribute} {
-    type: yesno
-    sql: ${TABLE}.#{attribute} ;;
-  }
-            LOOKML
+            Block.new(type: "dimension", name: attribute) do |b|
+              b << Field.new(name: "type", value: "yesno")
+              b << Field.new(name: "sql", value: "${TABLE}.#{attribute} ;;")
+            end
+          when ActiveModel::Type::String
+            Block.new(type: "dimension", name: attribute) do |b|
+              b << Field.new(name: "type", value: "string")
+              b << Field.new(name: "sql", value: "${TABLE}.#{attribute} ;;")
+            end
           when ActiveRecord::Type::DateTime, ActiveRecord::AttributeMethods::TimeZoneConversion::TimeZoneConverter
-            <<-LOOKML
-  dimension_group: #{attribute} {
-    type: time
-    sql: ${TABLE}.#{attribute} ;;
-  }
-            LOOKML
+            Block.new(type: "dimension_group", name: attribute) do |b|
+              b << Field.new(name: "type", value: "time")
+              b << Field.new(name: "sql", value: "${TABLE}.#{attribute} ;;")
+            end
           when ActiveRecord::Enum::EnumType
+            # @see https://github.com/rails/rails/blob/master/activerecord/lib/active_record/enum.rb
             enum_values = defined_enums[attribute]
-            when_lines_lookml = enum_values.map do |label, value|
-              <<-LOOKML
-      when: {
-        sql: ${TABLE}.#{attribute} = #{value} ;;
-        label: "#{label}"
-      }
-              LOOKML
-            end.join
 
-            <<-LOOKML
-  dimension: #{attribute} {
-    case: {
-#{when_lines_lookml}
-    }
-  }
-            LOOKML
+            Block.new(type: "dimension", name: attribute) do |b|
+              b << Block.new(type: "case", name: nil) do |b|
+                enum_values.map do |label, value|
+                  b << Block.new(type: "when", name: nil) do |b|
+                    b << Field.new(name: "sql", value: "${TABLE}.#{attribute} = #{value} ;;")
+                    b << Field.new(name: "label", value: "\"#{label}\"")
+                  end
+                end
+              end
+            end
           else
             raise "Unknown attribute type: #{attribute} #{type.class}"
           end

data/lib/active_record/lookml/field.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  module LookML
+    class Field
+      def initialize(name:, value:)
+        @name = name
+        @value = value
+      end
+
+      def to_lookml(indent_level: 0)
+        indent = '  ' * indent_level
+        "#{indent}#{@name}: #{@value}\n"
+      end
+    end
+  end
+end

data/lib/active_record/lookml/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module LookML
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-lookml
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Yoshinori Kawasaki
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,7 +86,10 @@ files:
 - bin/console
 - bin/setup
 - lib/active_record/lookml.rb
+- lib/active_record/lookml/array_field.rb
+- lib/active_record/lookml/block.rb
 - lib/active_record/lookml/core.rb
+- lib/active_record/lookml/field.rb
 - lib/active_record/lookml/version.rb
 - lib/activerecord-lookml.rb
 homepage: https://github.com/wantedly/activerecord-lookml