redash_backup 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0cead584b386318481ca5959092d07db19071cd30aac6d49ab6ee2db046370e
-  data.tar.gz: 32a1b925ef5a0ea7c7fc59cf7f5189e6bcf1cacc9a68a5f9f89d6f3bcd7a812b
+  metadata.gz: c8d3bca0628ca753fa535fc28d092e356afad31b6af555a1cf5c3fc9f81266aa
+  data.tar.gz: 82d03079e01fcff6efe875e94498f9bee3a0e20a6db56371ae870784cdaeb663
 SHA512:
-  metadata.gz: 909cf334f0ea9c301d6dd2d1dbd75e56ab51e5aabab8c2bbae400f9a7161ab572de27501d1ae693ac6fd2b8d324f9690dfc04e919cdbac4356b30320ec424fae
-  data.tar.gz: a4d37a4a180fdfea844df2755cd0de816cc36b31fc12f1fe332acecf15afdd726d9c375ca288d137b7d9fbfbdb266a8b7b4e9b74fe6142afa2e401c14cb80453
+  metadata.gz: 8f9cc4b37d8cd6ca1766ededa603e7afcaad8c24fcc5e97fd6e9a8feb79f53c55c119bae3864a4990add5fe0304dbfc1c8c108da4a510e14754ed45e362563e9
+  data.tar.gz: 82bf693e88a6fe29229b1d7c02da7a17a50467acaa38c710819418523ecaa40b838beae0dfdd96efcd3687f71f7fa05acc4f6e3aa20399b189688c919004c44d

data/CHANGELOG.md

@@ -1,2 +1,5 @@
 # 0.1.1
- - init🐣
+ - init🐣
+
+# 0.1.2
+ - export unused queries

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redash_backup (0.1.1)
+    redash_backup (0.1.2)
       activerecord (~> 6.0.2.1)
       fileutils (~> 0.7.2)
       pg (~> 1.2.2)
@@ -27,7 +27,7 @@ GEM
       concurrent-ruby (~> 1.0)
     minitest (5.14.0)
     pg (1.2.2)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -54,7 +54,7 @@ DEPENDENCIES
   bundler (~> 1.17)
   fileutils (~> 0.7.2)
   pg (>= 0.18, < 2.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   redash_backup!
   rspec (~> 3.0)
 

data/README.md

@@ -1,5 +1,7 @@
 # RedashBackup
 
+Simple Redash's query backup tool
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,5 +21,18 @@ Or install it yourself as:
 ## Usage
 
 ```
+  require 'redash_backup'
   RedashBackup.new('YOUR REDEDASH DATABASE_URL').execute('EXPORT DIR NAME')
+  #
+  # export...
+  #
+  # ./queries/dashboard1/hoge.sql
+  # ./queries/dashboard1/page.sql
+  # ./queries/dashboard2/poko.sql
+  # ./queries/dashboard2/pako.sql
+  # ./queries/unused/maru.sql
+  # ./queries/unused/batu.sql
+  #
+  # ※ default export path: './queries'
+  # 
 ```

data/lib/redash_backup/base.rb

@@ -0,0 +1,58 @@
+class RedashBackup::Base
+  def self.export!(dir)
+    new(dir).export
+  end
+
+  def initialize(dir)
+    @dir = dir
+    require 'redash_backup/model'
+  end
+
+  def export
+    FileUtils.rm_r(@dir) if Dir.exist? @dir
+    Dir.mkdir(@dir)
+    boards = Dashboard.active.all.find_each
+    boards.each { |board| export_by_board!(board) }
+    export_unused_queries!
+  end
+
+  private
+
+  def export_by_board!(board)
+    Dir.mkdir(@dir + '/' + board.name)
+    board.widgets.each do |widget|
+      query = widget.visualization&.query
+      next unless query
+
+      text = <<~TEXT
+        -- #{board.name}
+        -- #{query.name}
+        -- #{Time.now.strftime('%Y/%m/%d %H:%M')}
+
+        #{query.query}
+      TEXT
+      File.open(@dir + "/#{board.name}/#{query.name.gsub('/', '_')}.sql", 'w') do |file|
+        file.puts text
+      end
+    end
+    puts "Completed export to #{@dir}/#{board.name}/*.sql"
+  end
+
+  # unused: queries not attach to dashboard
+  def export_unused_queries!
+    Dir.mkdir(@dir + '/unused')
+    Query.inactive.all.find_each do |query|
+      text = <<~TEXT
+        -- ※ Not attached to dashboard
+        -- is_draft: #{query.is_draft}
+        -- #{Time.now.strftime('%Y/%m/%d %H:%M')}
+
+        #{query.query}
+      TEXT
+      File.open(@dir + "/unused/#{query.name.gsub('/', '_')}.sql", 'w') do |file|
+        file.puts text
+      end
+    end
+    puts "Completed export to #{@dir}/unused/*.sql"
+  end
+end

data/lib/redash_backup/model.rb

@@ -13,6 +13,14 @@ end
 
 class Query < Connector
   scope :active, -> { where(is_draft: false, is_archived: false) }
+  scope :inactive, -> do
+    left_joins(visualizations: { widgets: :dashboard })
+      .where('
+        queries.is_archived = false
+        AND dashboards.is_draft = false
+        AND dashboards.is_archived = false
+      ')
+  end
   has_many :visualizations
 end
 

data/lib/redash_backup/version.rb

@@ -1,3 +1,3 @@
 class RedashBackup
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/redash_backup.rb

@@ -1,35 +1,14 @@
 require "redash_backup/version"
+require "redash_backup/base"
 require 'fileutils'
 
 class RedashBackup
   def initialize(database_url)
     ENV['DATABASE_URL'] = database_url
-    require "redash_backup/model"
   end
 
   def execute(dir = './queries')
-    boards = Dashboard.active.all
-    FileUtils.rm_r(dir) if Dir.exist? dir
-    Dir.mkdir(dir)
-    boards.each do |board|
-      Dir.mkdir(dir + '/' + board.name)
-      board.widgets.each do |widget|
-        query = widget.visualization&.query
-        next unless query
-
-        text = <<~TEXT
-          -- #{board.name}
-          -- #{query.name}
-          -- #{Time.now.strftime('%Y/%m/%d %H:%M')}
-
-          #{query.query}
-        TEXT
-        File.open(dir + "/#{board.name}/#{query.name.gsub('/', '_')}.sql", 'w') do |file|
-          file.puts text
-        end
-      end
-      puts "Completed export to #{dir}/#{board.name}/*.sql"
-    end
+    RedashBackup::Base.export!(dir)
   end
 
   class Error < StandardError; end

data/redash_backup.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Tashiro"]
   spec.email         = ["g4160hc@gmail.com"]
 
-  spec.summary       = 'cli for back up redash queries'
+  spec.summary       = 'Simple Redash\'s query backup tool'
   spec.description   = 'cli for back up redash queries'
   spec.homepage      = 'https://github.com/tashirosota/ruby-redash_backup'
   spec.license       = "MIT"
@@ -38,6 +38,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'fileutils', '~> 0.7.2'
 
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redash_backup
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tashiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +114,7 @@ files:
 - bin/console
 - bin/setup
 - lib/redash_backup.rb
+- lib/redash_backup/base.rb
 - lib/redash_backup/model.rb
 - lib/redash_backup/version.rb
 - redash_backup.gemspec
@@ -142,5 +143,5 @@ requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: cli for back up redash queries
+summary: Simple Redash's query backup tool
 test_files: []