ruby_detective 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abe0950ab9ca4d1ed6e201099393deba959859cea88d1d2ca3467dacc38b00d9
-  data.tar.gz: ea9b99edf95de63499ae29a537d2031e312b2c0b7fa7e37947287dd67a96de3c
+  metadata.gz: 5c8aef4be729580d56700840749a062f8634b0c62b19fc9f744195eefa5f6a57
+  data.tar.gz: f265f8c31e1a7f18baa324797e3ee29b2094e1a1cbf1a46d3bbcb2982c632f88
 SHA512:
-  metadata.gz: 25e3f035527b125ee423a7b6689889681c935a72c2efe5fe8459cdc649a3050a499421dd005e8f9747b7283a048eda6ff43ca8bfea9439ad5040bfc8935eeb11
-  data.tar.gz: f7b9bb40ec643c51c8e4e2d20bf330a2c2b8b68428c03907f85fffa05cd0ddc46057b866e31510492cdffe1d13fff20acf5787639229b94d7008bafe14b307b2
+  metadata.gz: dd494208b3a50457dacd219fde9821704ce5f4cb10d326ef0afa4595fa6df1f4957f825ed51c8d2ecce0f52353ed6d4cbe7bd3bf4cdeacc8f32e2b1cc69da865
+  data.tar.gz: f492ecd6a0945640420f8c5e0f5bcc12ca78ecdbdf795dd06b0a9ef9df5788d64a398d173b1b8a5f4008b49d8dc97440b06c1db53bd8ca8be8af7232b61eb911

data/.gitignore

@@ -3,3 +3,4 @@ tmp/
 spec/examples.txt
 coverage/
 ruby_detective.html
+ruby_detective-*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_detective (0.0.0)
+    ruby_detective (0.0.3)
       parser (~> 2.6.5)
 
 GEM

data/README.md

@@ -1,11 +1,13 @@
 # Ruby Detective
-### Investigating your project dependencies
+### Investigating your code dependencies
 
-Ruby Detective is a gem that parses your code, finds it's dependencies and outputs a interactive .html file that you can use to explore the dependency network of the code.
+Ruby Detective is a gem that parses your code, finds it's dependencies and outputs an interactive .html file that you can use to explore the dependency network of the code.
 
-This is the UI for the Ruby Detective project by the way :smile:
+This is the UI for the Ruby Detective project by the way:
 
-![Preview](docs/preview.png?raw=true)
+### [Click here to access the live preview](https://victor-am.github.io/ruby_detective/preview.html)
+
+[![Preview](docs/preview.png?raw=true)](https://victor-am.github.io/ruby_detective/preview.html)
 
 ***:** Due to Ruby metaprogramming super-powers (and by extension Rails heavy use of those) it's unfeasible to find every single dependency, so we can only guarantee that explicit constants will be pointed as dependencies.
 
@@ -13,18 +15,20 @@ This is the UI for the Ruby Detective project by the way :smile:
 - Explorable and interactive network graph of the project dependencies
 - Graph nodes colored by namespace, making it easier to spot contexts
 - Useful information like lines of code, number of dependencies and dependents, etc
-- Fully self-contained .html file that can be easily shared
+- Outputs a fully self-contained .html file that can be easily shared
+
+## Installation
+**Make sure you have Ruby 2.5 or higher installed (lower versions are not supported)**
 
-## Instalation
 ```
-gem install ruby-detective
+gem install ruby_detective
 ```
 
 ## Usage
 
 ```
 cd my-project-folder
-ruby-detective .
+ruby_detective .
 ```
 
 This should output an html file at the end that is completely self-contained, and can be shared around with your peers :D
@@ -33,3 +37,5 @@ This should output an html file at the end that is completely self-contained, an
 - Click on a node to bring it's card to the top of the list on the left
 - Click twice on a node to add it to the graph, allowing to navigate through dependencies
 - Use the filters on the right to customize the graph, toggling off the "Show second-level dependency edges" option can be specially useful
+
+*This gem was inspired by @emad-elsaid library [rubrowser](https://github.com/emad-elsaid/rubrowser).*

data/Rakefile

@@ -7,3 +7,40 @@ begin
 rescue LoadError
   # no rspec available
 end
+
+desc "Rebuilds the template file in views/template.html.erb and commits it"
+task :build_ui do
+  system <<~SHELL
+    cd ui &&
+    yarn build &&
+    cd - &&
+    git add . &&
+    git commit -m 'Build the UI template'
+  SHELL
+end
+
+VERSION_LINE_REGEX = /s\.version.*$/
+GEMSPEC_FILE = "ruby_detective.gemspec"
+
+desc "Bumps the gem version and commits it with an annotated tag"
+task :bump_version, [:new_version] do |_t, args|
+  new_version = args[:new_version]
+
+  gemspec_file = File.read(GEMSPEC_FILE)
+  version_line = gemspec_file.scan(VERSION_LINE_REGEX).first
+
+  new_version_line = version_line.sub(/\d+\.\d+\.\d+/, new_version)
+  new_gemspec_file = gemspec_file.sub(VERSION_LINE_REGEX, new_version_line)
+  File.open(GEMSPEC_FILE, "w") {|file| file.puts new_gemspec_file }
+
+  system <<~SHELL
+    git add . &&
+    git commit -m 'Bump version to #{new_version}' &&
+    git tag v#{new_version}
+  SHELL
+end
+
+desc "Builds the gem"
+task :build_gem do
+  system "gem build ruby_detective.gemspec"
+end

data/ruby_detective.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "ruby_detective"
-  s.version     = "0.0.2"
+  s.version     = "0.0.3"
   s.date        = "2020-01-20"
   s.summary     = "Allows to investigate your ruby project dependency network"
   s.description = "Ruby Detective is a gem that parses your code, finds it's dependencies and outputs a interactive .html file that you can use to explore the dependency network of the code."