like_im_five 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a15ef4ccf7a86b9607360ca2a49606d3cc46b44ed6c1a3ba716cfc457b58342
+  data.tar.gz: 1702a26fc933d3d8eaba0756b4ca54d73b5e662e820da515945ceb4898086e97
+SHA512:
+  metadata.gz: a34a78a5856c216f49b64479ba0c154217e1035a888147ac2ff1d5fac1ddd9de76d31153cd6b6ff8b9229e16d42947f4881b22414a62976800dd9679ce275518
+  data.tar.gz: 8794426f305605d4ce4b7b2c17649f1d6004803631514ce8309174b6f362445b9bed89f66c5b4efa5d44dfa932a165f9bfb5d8a11ba22ce6452a8b1a706ba44c

data/README.md

@@ -0,0 +1,101 @@
+# like_im_five
+
+Do you use the awesome [factory_bot gem](https://github.com/thoughtbot/factory_bot) to create your contexts ?  
+Have you ever wasted time to set up testing context rather to be focus on the code ?  
+Have you ever had pain to write a long context because of unknow associations ?
+
+Like Im Five generate a file with factories you need to test a specific object. It use you DB development to retrieve the object you want and all associations you will have need to setup the test.
+
+**Create a complex testing context in a few seconds.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'like_im_five'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install like_im_five
+
+## Usage
+
+Just open you terminal, go in your project and type:
+
+`like_im_five id_of_object table_of_object`
+
+*(if you are facing somme issue try to prepend **bundle exec** before the commands above)*
+
+**It takes two parameters.**
+
+`id_of_object`  
+The gem use your development database so you have to indicate of which one object you would like create context.
+
+`table_of_object`  
+Then you have to specify what is the table of the `id` you just typed above.
+
+**Example:**
+
+In your DB development you have these objects:
+
+```ruby
+=> #<DummyApp::User id: 12 name: "Jean", city: "London", age: 20, created_at: "2019-12-30 22:45:33", updated_at: "2019-12-30 22:45:33">
+```
+```ruby
+=> #<DummyApp::Article id: 1, dummy_app_user_id: 12, dummy_app_category_id: 1, title: "Subway Art 25th", body: "Anniversary Edition", created_at: "2019-12-30 22:45:33", updated_at: "2019-12-30 22:45:33">
+```
+```ruby
+=> #<DummyApp::Category id: 1, dummy_app_topic_id: 3, label: "Graffiti", created_at: "2019-12-30 22:45:33", updated_at: "2019-12-30 22:45:33">
+```
+```ruby
+=> #<DummyApp::Topic id: 3, title: "Culture", description: "Culture is beautiful", created_at: "2019-12-30 22:45:33", updated_at: "2019-12-30 22:45:33">
+```
+
+You want to test your `article`, in your terminal you have to type the following command:
+
+`like_im_five 1 dummy_app_articles`
+
+and it will generate a new file in your `/spec` folder named: `data.txt` containing factories:
+
+```ruby
+let(:dummy_app_article) { create :dummy_app_article, id: 1, dummy_app_user_id: 12, dummy_app_category_id: 1, title: "Subway Art 25th", body: "Anniversary Edition" }
+let(:dummy_app_user) { create :dummy_app_user, id: 12, name: "Jean", city: "London", age: 20 }
+let(:dummy_app_category) { create :dummy_app_category, id: 1, label: "Graffiti", dummy_app_topic_id: 3 }
+let(:dummy_app_topic) { create :dummy_app_topic, id: 3, title: "Culture", description: "Culture is beautiful" }
+```
+
+That's it, just copy/paste it in your concerned spec.
+
+## Corner cases
+
+ - **UID**  
+I you are using `UID` rather than traditional `ID` no worries, we handle it for you. Just type commande below:
+
+`like_im_five "ffe-230-opoifhhfru-333" dummy_app_articles`
+
+  - **Similarity detection to match table name with model**  
+For some reason it can be useful to use `Inflection`, especially if you are not coding in english.
+
+If you named a table `vitraux` and your model `vitrail` we will match both to build your factory.
+
+*nb: if your model name is really to different than your table name it can fails to match.*
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/morissetcl/like_im_five. 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/morissetcl/like_im_five/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 LikeImFive project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/morissetcl/like_im_five/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/like_im_five

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby -wU
+require 'like_im_five'
+
+LikeImFive.call(ARGV)

data/lib/create_factory.rb

@@ -0,0 +1,23 @@
+require 'rails'
+
+class CreateFactory
+  class << self
+    def call(objects)
+      File.open("spec/data.txt", "w+") do |f|
+        objects.each do |object|
+          f.puts(formatte_factory(object))
+          f.puts("\n")
+        end
+      end
+    end
+
+    private
+
+    def formatte_factory(object)
+      atttributes_symbolized = object[:attributes][0].inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      formatted_attributes = atttributes_symbolized.to_s.delete(':').delete('{').delete('}').gsub("=>", ": ")
+      factory_name = object[:table].singularize.to_sym
+      "let(:#{factory_name}) { create :#{factory_name}, #{formatted_attributes} }"
+    end
+  end
+end

data/lib/extract_associated_object.rb

@@ -0,0 +1,57 @@
+require 'rails'
+require "rubygems/text"
+require_relative './create_factory'
+
+class ExtractAssociatedObject
+  attr_reader :object, :associated_object, :schema_tables
+
+  def initialize(object, associated_object = [])
+    @object = object[0]
+    @associated_object = associated_object
+    @schema_tables = ActiveRecord::Base.connection.tables
+  end
+
+  def call
+    associated_tables_names.each do |table, column|
+      value = object[column]
+      next if value.nil?
+
+      result = ActiveRecord::Base.connection.execute("SELECT * FROM #{table} WHERE id='#{value}'").to_a
+      result[0].delete('updated_at')
+      result[0].delete('created_at')
+      associated_object << { table: table, attributes: result }
+      ExtractAssociatedObject.new(result, associated_object).call
+    end
+    CreateFactory.call(associated_object)
+  end
+
+  private
+
+  def associated_tables_names
+    tables_names = []
+    object.select do |column|
+      next unless column.include?("_id")
+
+      table = column.split("_id").join.pluralize
+      if table_not_exist?(table)
+        table = find_closest_table_name(table)
+      end
+      tables_names << ["#{table}", column]
+    end
+    tables_names
+  end
+
+  def table_not_exist?(table)
+    !schema_tables.include?(table)
+  end
+
+  def find_closest_table_name(table)
+    schema_tables.each do |table_name|
+      levenshtein = Class.new.extend(Gem::Text).method(:levenshtein_distance)
+      similarity = levenshtein.call(table, table_name)
+      next if similarity > 3
+
+      return table_name
+    end
+  end
+end

data/lib/extract_specific_object.rb

@@ -0,0 +1,37 @@
+require 'rails'
+require 'active_record'
+require 'erb'
+require_relative './extract_associated_object'
+require_relative './general_configuration'
+
+class ExtractSpecificObject < GeneralConfiguration
+  class << self
+    def call(id:, table:)
+      initialize_configuration
+      return table_not_exist(table) unless ActiveRecord::Base.connection.tables.include?(table)
+
+      result = ActiveRecord::Base.connection.execute("SELECT * FROM #{table} WHERE id='#{id}'").to_a
+      return not_found(table, id) if result.blank?
+
+      remove_timestamps(result)
+
+      associated_object = [{ table: table, attributes: result }]
+      ExtractAssociatedObject.new(result, associated_object).call
+    end
+
+    private
+
+    def remove_timestamps(result)
+      result[0].delete('updated_at')
+      result[0].delete('created_at')
+    end
+
+    def not_found(table, id)
+      print "Can't find id=#{id} in table=#{table}"
+    end
+
+    def table_not_exist(table)
+      print "Table #{table} does not exist in your DB"
+    end
+  end
+end

data/lib/general_configuration.rb

@@ -0,0 +1,6 @@
+class GeneralConfiguration
+  def self.initialize_configuration
+    db_config = YAML.load(ERB.new(File.read('./config/database.yml')).result)
+    ActiveRecord::Base.establish_connection(db_config['development'])
+  end
+end

data/lib/like_im_five/version.rb

@@ -0,0 +1,3 @@
+module LikeImFive
+  VERSION = "1.0.0"
+end

data/lib/like_im_five.rb

@@ -0,0 +1,9 @@
+require "like_im_five/version"
+require "extract_specific_object"
+
+module LikeImFive
+  class Error < StandardError; end
+  def self.call(arg)
+    ExtractSpecificObject.call(id: arg[0], table: arg[1])
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: like_im_five
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Clément Morisset
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Like Im Five generate a file with factories you need to test a speific
+  object. It use you DB dévelopment to retrieve the object you want and all associations
+  you will have need to setup the test.
+email:
+- morissetcl87@gmail.com
+executables:
+- like_im_five
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/like_im_five
+- lib/create_factory.rb
+- lib/extract_associated_object.rb
+- lib/extract_specific_object.rb
+- lib/general_configuration.rb
+- lib/like_im_five.rb
+- lib/like_im_five/version.rb
+homepage: https://github.com/morissetcl
+licenses:
+- MIT
+metadata: {}
+post_install_message: Like Im Five installed! Thx.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Create a complex testing context in a few seconds.
+test_files: []