supercharts-bullet_train 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 462dbf009157408f444bbc319c8ad464cc917c82fec33d68c9fc1f4b5b72e1bd
-  data.tar.gz: 1d9372fbaf7adb909dcc43e571066e7216f5fb3c1b2931b6e301cadd3ee7f297
+  metadata.gz: 9f028c4e4c0144a3cc864dc7dfbfe3b04fe80462c1e602325e4520746a1c7e85
+  data.tar.gz: e1871658b39073aed06174cca8dc9528939b89a6cd6560259d9bfddd80f993d8
 SHA512:
-  metadata.gz: 18197a1a01eeade3ff7c85b205030d2ebc7e65ce422995cd61c1b1d0c6cf2debe06239a065b4906b97adfe97d5bc22d9e2755ddaa27da1f55f6c6e27a616a3d8
-  data.tar.gz: 06d0c93ac6e01850504f45049d03bafcd57e15bd54e425f9ff5ac8d34c648e2d62a0d51ef52d77c377ab5a86136c81b30a862624f933bc053327dcd54a8e3c19
+  metadata.gz: c4eaf6186a0186806bfaa6f616305bf00f8140a9543fb355237b2d37c0954abf4fc9a10ad6d1f9cb3175bbd4a532813afe3a784ff3625a03945d5d8c4104f707
+  data.tar.gz: 53d1ef43b3227b868443a9bb5c845d23caaa6432d0b955959f8fe44d9a6260a5eb8d265f69ac7b82d8ceeb12c6d60a87dde9d72cade2bb803062a2832ca051df

data/app/views/account/scaffolding/completely_concrete/tangible_things/tangible_things_chart/show.html.erb

@@ -24,13 +24,7 @@
         <div class="relative">
           <div data-supercharts--describable-target="overallDescription">
             <h2 class="text-xs uppercase dark:text-white/50">
-              <% if @timespan == "1w" %>
-                Tangible Things last 7 days
-              <% elsif @timespan == "1m" %>
-                Tangible Things last month
-              <% elsif @timespan == "ytd" %>
-                Tangible Things since start of year
-              <% end %>
+              <%= t(['tangible_things.chart.description', @timespan].join('.')) %>
             </h2>
             <p class="font-semibold dark:text-white mt-2" style="font-size: 1.8rem;">
               <%= @total %>
@@ -40,13 +34,7 @@
           <template data-supercharts--describable-target="contextualDescriptionTemplate">
             <p class="font-semibold dark:text-white mb-1" style="font-size: 1.6rem;">%value%</p>
             <p class="text-xs uppercase dark:text-white/50">
-              <% if @period == :day %>
-                Tangible Things on <span class="whitespace-nowrap">%label%</span>
-              <% elsif @period == :week %>
-                Tangible Things in <span class="whitespace-nowrap">%label%</span>
-              <% elsif @period == :month %>
-                Tangible Things in <span class="whitespace-nowrap">%label%</span>
-              <% end %>
+              <%= t(['tangible_things.chart.contextual_description', @timespan].join('.')).html_safe %>
             </p>
           </template>
         </div>
@@ -56,9 +44,9 @@
           >
             <div class="flex items-center justify-center">
               <div class="inline-flex space-x-1" role="group">
-                <%= render "shared/supercharts/filter_button", path: polymorphic_path([:account, @absolutely_abstract_creative_concept, :tangible_things, :chart], timespan: "1w"), label: "1w", first: true %>
-                <%= render "shared/supercharts/filter_button", path: polymorphic_path([:account, @absolutely_abstract_creative_concept, :tangible_things, :chart], timespan: "1m"), label: "1m" %>
-                <%= render "shared/supercharts/filter_button", path: polymorphic_path([:account, @absolutely_abstract_creative_concept, :tangible_things, :chart], timespan: "ytd"), label: "ytd", last: true %>
+                <%= render "shared/supercharts/filter_button", label: t("tangible_things.chart.filters.1w.abbr"), alt: t("tangible_things.chart.filters.1w.label"), path: polymorphic_path([:account, @absolutely_abstract_creative_concept, :tangible_things, :chart], timespan: "1w"), first: true %>
+                <%= render "shared/supercharts/filter_button", label: t("tangible_things.chart.filters.1m.abbr"), alt: t("tangible_things.chart.filters.1m.label"), path: polymorphic_path([:account, @absolutely_abstract_creative_concept, :tangible_things, :chart], timespan: "1m") %>
+                <%= render "shared/supercharts/filter_button", label: t("tangible_things.chart.filters.ytd.abbr"), alt: t("tangible_things.chart.filters.ytd.label"), path: polymorphic_path([:account, @absolutely_abstract_creative_concept, :tangible_things, :chart], timespan: "ytd"), last: true %>
               </div>
             </div>
             <template data-supercharts--filters-target="data">
@@ -77,13 +65,7 @@
       data-action="update-chart->superchart#updateChart"
     >
       <canvas data-superchart-target="chartjsCanvas" style="height: var(--chart-height)">
-        <% if @timespan == "1w" %>
-          Chart of Tangible Things last 7 days
-        <% elsif @timespan == "1m" %>
-          Chart of Tangible Things last month
-        <% elsif @timespan == "ytd" %>
-          Chart of Tangible Things since start of year
-        <% end %>
+        <%= t(['tangible_things.chart.alt_description', @timespan].join('.')) %>
       </canvas>
       <template data-superchart-target="csvData" data-supercharts--filterable-target="chartSourceData"></template>
       <template data-superchart-target="chartjsOptions"></template>

data/app/views/shared/supercharts/_filter_button.html.erb

@@ -2,8 +2,15 @@
   first ||= false
   last ||= false
   label ||= "link"
+  alt ||= nil
   path ||= ""
   button_classes = "px-5 py-1.5 dark:text-white font-small text-xs leading-tight uppercase hover:bg-blue-800/50 hover:text-white focus:bg-blue-700 focus:outline-none focus:ring-0 active:bg-blue-800 transition duration-150 ease-in-out rounded-lg"
+  options = {
+    class: [button_classes, "bg-gray-400 dark:bg-blue-800 text-white hover:bg-blue-400 dark:hover:bg-blue-800/100": current_page?(path)]
+  }
+  unless alt.nil?
+    options[:title] = alt.upcase_first
+  end
 %>
 
-<%= link_to label, path, class: [button_classes, "bg-gray-400 dark:bg-blue-800 text-white hover:bg-blue-400 dark:hover:bg-blue-800/100": current_page?(path)] %>
+<%= link_to label, path, options %>

data/lib/bullet_train/supercharts/engine.rb

@@ -3,9 +3,9 @@ module BulletTrain
     class Engine < ::Rails::Engine
       initializer "bullet_train.super_scaffolding.templates.register_template_path" do |app|
         # Register the base path of this package with the Super Scaffolding engine.
-        BulletTrain::SuperScaffolding.template_paths << File.expand_path('../../../..', __FILE__)
+        BulletTrain::SuperScaffolding.template_paths << File.expand_path("../../../..", __FILE__)
         BulletTrain::SuperScaffolding.scaffolders.merge!({
-          "supercharts:chart" => "BulletTrain::Supercharts::Scaffolders::ChartScaffolder",
+          "supercharts:chart" => "BulletTrain::Supercharts::Scaffolders::ChartScaffolder"
         })
       end
     end

data/lib/bullet_train/supercharts/scaffolders/chart_scaffolder.rb

@@ -19,14 +19,14 @@ module BulletTrain
             puts ""
             exit
           end
-          
+
           target_model, parent_models = argv
           parent_models = parent_models.split(",")
           parent_models += ["Team"]
           parent_models = parent_models.map(&:classify).uniq
 
           transformer = Scaffolding::SuperchartsChartTransformer.new(target_model, parent_models)
-          
+
           transformer.scaffold_supercharts
         end
       end

data/lib/bullet_train/supercharts/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Supercharts
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/lib/scaffolding/app/controllers/account/scaffolding/completely_concrete/tangible_things/tangible_things_chart_controller.rb

@@ -1,4 +1,4 @@
-require 'csv'
+require "csv"
 
 class Account::Scaffolding::CompletelyConcrete::TangibleThings::TangibleThingsChartController < Account::ApplicationController
   include ActionView::Helpers::NumberHelper
@@ -7,18 +7,18 @@ class Account::Scaffolding::CompletelyConcrete::TangibleThings::TangibleThingsCh
   # GET /account/scaffolding/absolutely_abstract/creative_concepts/:absolutely_abstract_creative_concept_id/completely_concrete/tangible_things/chart
   def show
     @tangible_things = @absolutely_abstract_creative_concept.completely_concrete_tangible_things
-    
+
     @timespan = params[:timespan]
     case @timespan
     when "ytd"
       range = Time.now.beginning_of_year..Time.now
       range_days = (range.max - range.min).seconds.in_days
-      if range_days > 4.months.in_days
-        @period = :month
+      @period = if range_days > 4.months.in_days
+        :month
       elsif range_days > 1.month.in_days
-        @period = :week
+        :week
       else
-        @period = :day
+        :day
       end
       series = @tangible_things.group_by_period(@period, :created_at, range: range, expand_range: true)
     when "1w"
@@ -30,26 +30,13 @@ class Account::Scaffolding::CompletelyConcrete::TangibleThings::TangibleThingsCh
       @period = :day
       series = @tangible_things.group_by_period(@period, :created_at, range: range)
     end
-    
+
     counts = series.count
     @total = counts.values.reduce(:+)
-    
-    date_format_abbr = if @period == :day
-      "%e"
-    elsif @period == :week
-      "Week of %b %e"
-    elsif @period == :month
-      "%b"
-    end
-    
-    date_format_full = if @period == :day
-      "%B %e"
-    elsif @period == :week
-      "week of %B %e"
-    elsif @period == :month
-      "%B, %Y"
-    end
-    
+
+    date_format_abbr = t(["tangible_things.chart.date_abbr", @period].join("."))
+    date_format_full = t(["tangible_things.chart.date_full", @period].join("."))
+
     @csv = CSV.generate(" ", headers: %w[date_abbr date_full count count_formatted], write_headers: true, encoding: "UTF-8") do |csv|
       counts.each do |date, count|
         csv.add_row [date.strftime(date_format_abbr), date.strftime(date_format_full), count, number_with_delimiter(count)]

data/lib/scaffolding/supercharts_chart_transformer.rb

@@ -1,16 +1,18 @@
 require "scaffolding/supercharts_transformer"
 
 class Scaffolding::SuperchartsChartTransformer < Scaffolding::SuperchartsTransformer
+  RUBY_NEW_CHARTS_HOOK = "# 📈 super scaffolding will insert new charts above this line."
+
   def scaffold_supercharts
     super
-    
+
     # copy files over and do the appropriate string replace.
     files = [
       "./lib/scaffolding/app/controllers/account/scaffolding/completely_concrete/tangible_things/tangible_things_chart_controller.rb",
       "./app/views/account/scaffolding/completely_concrete/tangible_things/tangible_things_chart",
-      "./app/views/shared/supercharts",
+      "./app/views/shared/supercharts"
     ].compact
-    
+
     files.each do |name|
       if File.directory?(resolve_template_path(name))
         scaffold_directory(name)
@@ -18,14 +20,64 @@ class Scaffolding::SuperchartsChartTransformer < Scaffolding::SuperchartsTransfo
         scaffold_file(name)
       end
     end
-    
+
+    # locale
+    locale_file = "./config/locales/en/scaffolding/completely_concrete/tangible_things.en.yml"
+
+    # add locale file if missing
+    unless File.file?(transform_string(locale_file))
+      scaffold_file(locale_file)
+      add_locale_helper_export_fix
+    end
+
+    # add locale strings for chart
+    scaffold_add_line_to_file(locale_file, RUBY_NEW_CHARTS_HOOK, "  account:", prepend: true, increase_indent: true, exact_match: true)
+    # ensure the right indentation
+    scaffold_replace_line_in_file(locale_file, "    #{RUBY_NEW_CHARTS_HOOK}", "  #{RUBY_NEW_CHARTS_HOOK}")
+
+    locale_yaml = <<~YAML
+      chart:
+        filters:
+          1w: 
+            abbr: 1w
+            label: "last week"
+          1m:
+            abbr: 1m
+            label: "last month"
+          ytd:
+            abbr: ytd
+            label: "year to date"
+        description:
+          1w: Tangible Things last 7 days
+          1m: Tangible Things last month
+          ytd: Tangible Things since start of year
+        contextual_description:
+          1w: Tangible Things on <span class="whitespace-nowrap">%label%</span>
+          1m: Tangible Things in <span class="whitespace-nowrap">%label%</span>
+          ytd: Tangible Things in <span class="whitespace-nowrap">%label%</span>
+        alt_description:
+          1w: Chart of Tangible Things last 7 days
+          1m: Chart of Tangible Things last month
+          ytd: Chart of Tangible Things since start of year
+        date_abbr:
+          day: "%e"
+          week: "Week of %b %e"
+          month: "%b"
+        date_full:
+          day: "%B %e"
+          week: "week of %B %e"
+          month: "%B, %Y"
+    YAML
+
+    scaffold_add_line_to_file("./config/locales/en/scaffolding/completely_concrete/tangible_things.en.yml", locale_yaml, RUBY_NEW_CHARTS_HOOK, prepend: true)
+
     # add children to the show page of their parent.
     unless cli_options["skip-parent"] || parent == "None"
       lines_to_add = <<~RUBY
         <div class="mt-4 [--chart-height:150px] md:[--chart-height:200px]">
           <%= turbo_frame_tag :charts_tangible_things, src: polymorphic_path([:account, @creative_concept, :tangible_things, :chart], timespan: "1m") do %>
             <%= render "shared/supercharts/chart_skeleton" do %>
-              Tangible Things&hellip;
+              <%= t('tangible_things.label') %>&hellip;
             <% end %>
           <% end %>
         </div>
@@ -37,53 +89,53 @@ class Scaffolding::SuperchartsChartTransformer < Scaffolding::SuperchartsTransfo
         prepend: true
       )
     end
-    
+
     # add user permissions.
     add_ability_line_to_roles_yml
-    
+
     # apply routes.
     # TODO this is a hack and should be in its own RouteFileManipulator class
     lines = File.read("config/routes.rb").lines.map(&:chomp)
     account_namespace_found = false
-    
+
     lines.each_with_index do |line, index|
       if line.match?("namespace :account do")
         account_namespace_found = true
       elsif account_namespace_found && line.match?(transform_string("resources :tangible_things"))
         chart_resource_lines = transform_string("collection do\nresource :chart, only: :show, module: :tangible_things, as: :tangible_things_chart, controller: :tangible_things_chart\nend")
-        if line.match? /do$/
-          lines[index] = "#{line}\n#{chart_resource_lines}\n"
+        lines[index] = if line.match?(/do$/)
+          "#{line}\n#{chart_resource_lines}\n"
         else
-          lines[index] = "#{line} do\n#{chart_resource_lines}\nend"
+          "#{line} do\n#{chart_resource_lines}\nend"
         end
       end
     end
-    
+
     File.write("config/routes.rb", lines.join("\n"))
-    
+
     puts `standardrb --fix ./config/routes.rb`
-    
+
     restart_server unless ENV["CI"].present?
   end
-  
+
   def parent_show_file
     @target_show_file ||= "./app/views/account/scaffolding/absolutely_abstract/creative_concepts/show.html.erb"
   end
-  
+
   def transform_string(string)
     [
       "Scaffolding::CompletelyConcrete::TangibleThings::TangibleThingsChart",
-      "lib/scaffolding/app",
+      "lib/scaffolding/app"
     ].each do |needle|
       # TODO There might be more to do here?
       # What method is this calling?
       string = string.gsub(needle, encode_double_replacement_fix(replacement_for(needle)))
     end
-    
+
     string = super(string)
     decode_double_replacement_fix(string)
   end
-  
+
   def replacement_for(string)
     case string
     when "Scaffolding::CompletelyConcrete::TangibleThings::TangibleThingsChart"
@@ -94,4 +146,4 @@ class Scaffolding::SuperchartsChartTransformer < Scaffolding::SuperchartsTransfo
       "🛑"
     end
   end
-end
+end

data/lib/scaffolding/supercharts_routes_file_manipulator.rb

@@ -1,85 +1,83 @@
 class Scaffolding::SuperchartsRoutesFileManipulator < Scaffolding::RoutesFileManipulator
-  
   def apply(base_namespaces, prepend_namespace_to_child: nil)
     child_namespaces, child_resource, parent_namespaces, parent_resource = divergent_parts
-  
+
     within = find_or_create_namespaces(base_namespaces)
-    
+
     # e.g. Project and Projects::Deliverable
     if parent_namespaces.empty? && child_namespaces.one? && parent_resource == child_namespaces.first
-  
+
       # resources :projects do
       #   scope module: 'projects' do
       #     resources :deliverables, only: collection_actions
       #   end
       # end
-      
+
       parent_within = find_or_convert_resource_block(parent_resource, within: within)
-  
+
       # add the new resource within that namespace.
       line = "scope module: '#{parent_resource}' do"
       # TODO you haven't tested this yet.
       unless (scope_within = find(/#{line}/, parent_within))
         scope_within = insert([line, "end"], parent_within)
       end
-  
+
       find_or_create_resource([child_resource], options: "only: collection_actions", within: scope_within)
-  
+
       # namespace :projects do
       #   resources :deliverables, except: collection_actions
       # end
-  
+
       # We want to see if there are any namespaces one level above the parent itself,
       # because namespaces with the same name as the resource can exist on the same level.
       parent_block_start = find_block_parent(parent_within)
       namespace_line_within = find_or_create_namespaces(child_namespaces, parent_block_start)
-      
+
       if prepend_namespace_to_child.present?
         namespace_line_within = find_or_create_namespaces([prepend_namespace_to_child], namespace_line_within)
       end
-      
+
       find_or_create_resource([child_resource], options: "except: collection_actions", within: namespace_line_within)
       unless find_namespaces(child_namespaces, within)[child_namespaces.last]
         raise "tried to insert `namespace :#{child_namespaces.last}` but it seems we failed"
       end
-  
+
     # e.g. Projects::Deliverable and Objective Under It, Abstract::Concept and Concrete::Thing
     elsif parent_namespaces.any?
-  
+
       # namespace :projects do
       #   resources :deliverables
       # end
       top_parent_namespace = find_namespaces(parent_namespaces, within)[parent_namespaces.first]
-      
+
       find_or_create_resource(child_namespaces + [child_resource], within: top_parent_namespace)
-  
+
       # resources :projects_deliverables, path: 'projects/deliverables' do
       #   resources :objectives
       # end
       block_parent_within = find_block_parent(top_parent_namespace)
       parent_namespaces_and_resource = (parent_namespaces + [parent_resource]).join("_")
       parent_within = find_or_create_resource_block([parent_namespaces_and_resource], options: "path: '#{parent_namespaces_and_resource.tr("_", "/")}'", within: block_parent_within)
-      
+
       if prepend_namespace_to_child.present?
         parent_within = find_or_create_namespaces([prepend_namespace_to_child], parent_within)
       end
-      
+
       find_or_create_resource(child_namespaces + [child_resource], within: parent_within)
     else
-  
+
       begin
         within = find_or_convert_resource_block(parent_resource, within: within)
       rescue
         within = find_or_convert_resource_block(parent_resource, options: "except: collection_actions", within: within)
       end
-      
+
       if prepend_namespace_to_child.present?
         within = find_or_create_namespaces([prepend_namespace_to_child], within)
       end
-      
+
       find_or_create_resource(child_namespaces + [child_resource], options: define_concerns, within: within)
-  
+
     end
   end
-  
-end
+end

data/lib/scaffolding/supercharts_transformer.rb

@@ -2,18 +2,16 @@ class Scaffolding::SuperchartsTransformer < Scaffolding::Transformer
   def initialize(child, parents, cli_options = {})
     super(child, parents, cli_options)
   end
-  
+
   def scaffold_supercharts
-    begin
-      # Update the routes to add the namespace and base resource
-      routes_manipulator = Scaffolding::RoutesFileManipulator.new("config/routes.rb", transform_string("Scaffolding::CompletelyConcrete::TangibleThings"), transform_string("Scaffolding::AbsolutelyAbstract::CreativeConcept"))
-      routes_manipulator.apply(["account"])
-      Scaffolding::FileManipulator.write("config/routes.rb", routes_manipulator.lines)
-    rescue BulletTrain::SuperScaffolding::CannotFindParentResourceException => exception
-      # TODO It would be great if we could automatically generate whatever the structure of the route needs to be and
-      # tell them where to try and inject it. Obviously we can't calculate the line number, otherwise the robots would
-      # have already inserted the routes, but at least we can try to do some of the complicated work for them.
-      add_additional_step :red, "We were not able to generate the routes for your Action Model automatically because: \"#{exception.message}\" You'll need to add them manually, which admittedly can be complicated. See https://blog.bullettrain.co/nested-namespaced-rails-routing-examples/ for guidance. 🙇🏻‍♂️"
-    end
+    # Update the routes to add the namespace and base resource
+    routes_manipulator = Scaffolding::RoutesFileManipulator.new("config/routes.rb", transform_string("Scaffolding::CompletelyConcrete::TangibleThings"), transform_string("Scaffolding::AbsolutelyAbstract::CreativeConcept"))
+    routes_manipulator.apply(["account"])
+    Scaffolding::FileManipulator.write("config/routes.rb", routes_manipulator.lines)
+  rescue BulletTrain::SuperScaffolding::CannotFindParentResourceException => exception
+    # TODO It would be great if we could automatically generate whatever the structure of the route needs to be and
+    # tell them where to try and inject it. Obviously we can't calculate the line number, otherwise the robots would
+    # have already inserted the routes, but at least we can try to do some of the complicated work for them.
+    add_additional_step :red, "We were not able to generate the routes for your Action Model automatically because: \"#{exception.message}\" You'll need to add them manually, which admittedly can be complicated. See https://blog.bullettrain.co/nested-namespaced-rails-routing-examples/ for guidance. 🙇🏻‍♂️"
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supercharts-bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Pascal Laliberté
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-09 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails