chemlab 0.4.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07bc21e85bd30535258248b34722848feed23de49fea1217442efa6f5fe86f9b
-  data.tar.gz: d38fbd55e058dfdc124d3d497fc45928bdea73c3eceaaf7f81c7330f18d793bb
+  metadata.gz: b5adc75f1131d78970aa177e504bd9054b1bf07aab8c7bb2cbf0056fb81fa889
+  data.tar.gz: e1089e0141e142684cb6eac2dfac48a4383cd043d32902362f7c26b45c8b52a3
 SHA512:
-  metadata.gz: 2f621b4f87dbf07474a77fb2ad309b9cfbbb34cc9f1e5158bfc343d58e3005d5612ee38f8877410c444c44280031f2bb67a2516d078c08e22071a16f726dd1a1
-  data.tar.gz: e837e155b3743c861e238de0da9f3306a5a2222c6df73d4fdb3d7655626ca05c2cefd89f8db5433023c8a65f2df3378190818aef1bee9d63564e7f6b4369a811
+  metadata.gz: bdcad6b56b68d707a83cf9d932eb290d272e48b2c67c24ee0c5f2e4fe2e158b3bff80268652780d344da0e4b7f922634549b9a02601a19adcc0c73c1019913ab
+  data.tar.gz: f0856ad93ae0b5f18f9b0590f1ba897418d9e0ba2557da225fcea29f448c868d528eb4e04b5d09753a3f7572a859711aaf1ad59bc3344665637703ebf7b3fd78

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks' # load bundler gem tasks such as `build`, `release` to help maintain Chemlab Libraries
+
+# enable metadata. this is required for --help
+Rake::TaskManager.record_task_metadata = true
+
+Dir[File.expand_path('lib/tasks/**/*.rake', __dir__)].each { |f| Rake.load_rakefile(f) }

data/bin/chemlab

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rake'
+
+Rake.load_rakefile(File.expand_path('../Rakefile', __dir__))
+
+task = ARGV.shift
+
+Rake::Task[task].execute(ARGV)

data/bin/chemlab-suite

@@ -0,0 +1 @@
+bin/chemlab

data/bin/chemlab-test

@@ -0,0 +1 @@
+bin/chemlab

data/lib/chemlab.rb

@@ -2,19 +2,9 @@
 
 require 'watir'
 
-require 'chemlab/configuration'
-require 'chemlab/attributable'
-require 'chemlab/runtime/env'
-require 'chemlab/runtime/browser'
-require 'chemlab/element'
-require 'chemlab/component'
-require 'chemlab/page'
-require 'chemlab/support/api'
-require 'chemlab/api_fabricator'
-require 'chemlab/resource'
-
 # Chemlaboratory
 module Chemlab
+  autoload :Version, 'chemlab/version'
 
   # Yields the global configuration to a block.
   # @yield [Configuration] global configuration
@@ -23,18 +13,38 @@ module Chemlab
   #     Chemlab.configure do |config|
   #       config.base_url = 'https://example.com'
   #     end
-  def self.configure
-    yield configuration if block_given?
+  def self.configure(&block)
+    yield configuration(&block) if block_given?
   end
 
-  # Returns the global [Configuration](Configuration) object. While
+  # Returns the global [Chemlab::Configuration] object. While
   # you _can_ use this method to access the configuration, the more common
   # convention is to use Chemlab.configure.
   #
   # @example
-  #     Chemlab.configuration.drb_port = 1234
+  #     Chemlab.configuration.something = 1234
   # @see Chemlab.configure
-  def self.configuration
-    @configuration ||= Chemlab::Configuration.new
+  def self.configuration(&block)
+    @configuration ||= Chemlab::Configuration.new(&block)
+  end
+
+  autoload :Configuration, 'chemlab/configuration'
+  autoload :Attributable, 'chemlab/attributable'
+
+  autoload :Element, 'chemlab/element'
+  autoload :Component, 'chemlab/component'
+  autoload :Page, 'chemlab/page'
+
+  # Runtime modules
+  module Runtime
+    autoload :Env, 'chemlab/runtime/env'
+    autoload :Browser, 'chemlab/runtime/browser'
+    autoload :Logger, 'chemlab/runtime/logger'
+  end
+
+  module CLI
+    autoload :Generator, 'chemlab/cli/generator'
+    autoload :Stubber, 'chemlab/cli/stubber'
+    autoload :NewLibrary, 'chemlab/cli/new_library'
   end
 end

data/lib/chemlab/attributable.rb

@@ -7,18 +7,24 @@ module Chemlab
   #     include Attributable
   #     attribute :url
   #     attribute :id
-  #     attribute :name { 'test' }
+  #     attribute :name do
+  #       'test'
+  #     end
   module Attributable
-    def attribute(name)
-      default_value = nil
-      default_value = yield if block_given?
+    def self.included(base)
+      base.class_eval do
+        def self.attribute(name)
+          default_value = nil
+          default_value = yield if block_given?
 
-      define_method(name) do
-        instance_variable_get("@#{name}") ||
-          instance_variable_set(
-            "@#{name}",
-            default_value
-          )
+          define_method(name) do
+            instance_variable_get("@#{name}") ||
+              instance_variable_set(
+                "@#{name}",
+                default_value
+              )
+          end
+        end
       end
     end
   end

data/lib/chemlab/cli/fixtures/new_library/.gitignore

@@ -0,0 +1,63 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/ruby
+# Edit at https://www.toptal.com/developers/gitignore?templates=ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# End of https://www.toptal.com/developers/gitignore/api/ruby
+.idea/

data/lib/chemlab/cli/fixtures/new_library/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/lib/chemlab/cli/fixtures/new_library/README.md.erb

@@ -0,0 +1 @@
+# <%= library[:name] %> Library for Chemlab

data/lib/chemlab/cli/fixtures/new_library/lib/new_library.rb.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module <%= library[:classified_name] %>
+  module Page
+    autoload :Sample, 'page/sample'
+  end
+end

data/lib/chemlab/cli/fixtures/new_library/lib/page/sample.rb.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module <%= library[:classified_name] %>
+  module Page
+    class Sample < Chemlab::Page
+      path '/sample'
+    end
+  end
+end

data/lib/chemlab/cli/fixtures/new_library/new_library.gemspec.erb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name = '<%= library[:name] %>'
+  spec.version = '0.0.1'
+  spec.authors = ['Me <me@example.com>']
+  spec.email = []
+
+  spec.summary = 'Page Libraries for <%= library[:name] %>'
+  spec.homepage = ''
+  spec.license = ''
+
+  spec.files = `git ls-files -- lib/*`.split("\n")
+
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency 'rspec'
+
+  spec.add_runtime_dependency 'chemlab'
+end

data/lib/chemlab/cli/fixtures/new_library/spec/integration/page/sample_spec.rb.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true %>
+
+module <%= library[:classified_name] %>
+  module Page
+    RSpec.describe '<%= library[:classified_name] %>' do
+      before do
+        Page::Sample.perform(&:visit)
+      end
+
+      it 'should have all elements upon navigation' do
+        Page::Sample.perform do |sample|
+          expect(sample).to be_visible
+        end
+      end
+    end
+  end
+end

data/lib/chemlab/cli/fixtures/new_library/spec/unit/page/sample_spec.rb.erb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true %>
+
+module <%= library[:classified_name] %>
+  module Page
+    RSpec.describe Sample do
+      describe '.path' do
+        it 'should have the correct path' do
+          expect(described_class.path).to eq('/sample')
+        end
+      end
+
+      describe 'elements' do
+        it 'should have elements defined' do
+          expect(described_class.public_elements).not_to be_empty
+        end
+      end
+    end
+  end
+end

data/lib/chemlab/cli/generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module Chemlab
+  module CLI
+    # Base Chemlab class generator ($ chemlab generate ...)
+    module Generator
+      extend self
+
+      INVALID_GENERATOR_ERROR = <<~ERR
+        Cannot generate `%s` as the generator does not exist.
+        Possible options are %s.
+      ERR
+
+      def generate(what, name, args)
+        raise ArgumentError, 'Please specify what to generate' unless what
+        raise ArgumentError, 'Please specify a name' unless name
+
+        unless possible_generators.has_key?(what)
+          raise ArgumentError, INVALID_GENERATOR_ERROR % what,
+                possible_generators.keys.join(',')
+        end
+
+        data = args.each_with_object({}) do |arg, h|
+          k, v = arg.split('=')
+          h[k] = v
+        end
+
+        # render the erb
+        $stdout.puts ERB.new(File.read(possible_generators[what]),
+                             trim_mode: '%<>').result_with_hash({ data: data, name: name })
+      end
+
+      private
+
+      # List the possible generators
+      # @return [Hash] { 'generator' => 'templates/generator.erb' }
+      def possible_generators
+        Dir[File.expand_path('./generator/templates/*.erb', __dir__)].each_with_object({}) do |generator, generators|
+          generators[File.basename(generator)[0..-5]] = generator
+        end
+      end
+    end
+  end
+end

data/lib/chemlab/cli/generator/templates/page.erb

@@ -0,0 +1,3 @@
+class <%= name %> < Chemlab::Page
+<%= props = +''; data.each_key { |k| props << "  #{k} '#{data[k]}'\n" }; props %>
+end

data/lib/chemlab/cli/new_library.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'tmpdir'
+
+module Chemlab
+  module CLI
+    # New Library generator module
+    module NewLibrary
+      module_function
+
+      # Scaffold a library by name
+      # @param [String] library_name the name of the library to scaffold
+      def scaffold(library_name)
+        if Dir.exist?(library_name)
+          raise %(Cannot create new library `#{library_name}` as the directory "#{library_name}" already exists)
+        end
+
+        require 'active_support/core_ext/string/inflections'
+
+        @library = {
+          name: library_name,
+          classified_name: library_name.tr('-', '_').classify,
+          underscored_name: library_name.underscore
+        }
+
+        $stdout.print %(Scaffolding new library in "#{library_name}/"...)
+
+        Dir.mktmpdir(library_name) do |dir|
+          # copy the fixture folder into the tmp folder and name the directory #{library_name}
+          root_dir = File.join(dir, library_name)
+          FileUtils.copy_entry(File.expand_path('./fixtures/new_library', __dir__), root_dir)
+
+          # rename all `new_library` references to #{library_name}
+          Dir.glob(File.join(root_dir, '**', 'new_library*')) do |file|
+            FileUtils.move(file, file.gsub('new_library', library_name))
+          end
+
+          Dir["#{root_dir}/**/*.erb"].each do |template|
+            File.open(template[0..-5], 'w') do |file|
+              file.puts ERB.new(File.read(template), trim_mode: '%<>').result_with_hash({ library: @library })
+              File.delete(template)
+            end
+          end
+
+          FileUtils.move(File.join(dir, library_name), library_name)
+        end
+
+        $stdout.print " Done\n"
+      end
+
+      # Render a given file
+      # @param [File] source the source file
+      # @note This method will replace `new_library` with the library
+      # @return [String] the destination
+      def render_file(source)
+        puts "Rendering: #{source}"
+        # Dir.mkdir(@tmp_destination)
+      end
+    end
+  end
+end

data/lib/chemlab/cli/stub.erb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+<% generation_message = '# This is a stub, used for indexing. The method is dynamically generated' %>
+<% modules = library.to_s.split('::') %>
+<% root = ('  ' * modules.size) %>
+<% modules.each_with_index do |mod, indent| %>
+<%= ('  ' * indent) %><%= "module #{mod}\n" %>
+<% end %>
+<% library.public_elements.each do |element| %>
+
+<% if Chemlab::Element::CLICKABLES.include?(element[:type]) %>
+<%= root %># @note Defined as +<%= "#{element[:type]} :#{element[:name]}" %>+
+<%= root %># Clicks +<%= element[:name] %>+
+<%= root %>def <%= element[:name] %>
+
+<%= root %>  <%= generation_message %>.
+<%= root %>end
+
+<% else %>
+<%= root %># @note Defined as +<%= "#{element[:type]} :#{element[:name]}" %>+
+<%= root %># @return [String] The text content or value of +<%= element[:name] %>+
+<%= root %>def <%= element[:name] %>
+
+<%= root %>  <%= generation_message %>.
+<%= root %>end
+
+<% end %>
+
+<% if Chemlab::Element::INPUTS.include?(element[:type]) %>
+<%= root %># Set the value of <%= element[:name] %>
+
+<%= root %># @example
+<%= root %>#   <%= library.to_s %>.perform do |<%= modules.last.underscore %>|
+<%= root %>#     <%= modules.last.underscore %>.<%= element[:name] %> = 'value'
+<%= root %>#   end
+<%= root %># @param value [String] The value to set.
+<%= root %>def <%= element[:name] %>=(value)
+<%= root %>  <%= generation_message %>.
+<%= root %>end
+<% end %>
+
+<%= root %># @example
+<%= root %>#   <%= library.to_s %>.perform do |<%= modules.last.underscore %>|
+<%= root %>#     expect(<%= modules.last.underscore %>.<%= element[:name] %>_element).to exist
+<%= root %>#   end
+<%= root %># @return [Watir::<%= element[:type].to_s.classify %>] The raw +<%= element[:type].to_s.classify %>+ element
+<%= root %>def <%= element[:name] %>_element
+<%= root %>  <%= generation_message %>.
+<%= root %>end
+
+<%= root %># @example
+<%= root %>#   <%= library.to_s %>.perform do |<%= modules.last.underscore %>|
+<%= root %>#     expect(<%= modules.last.underscore %>).to be_<%= element[:name] %>
+
+<%= root %>#   end
+<%= root %># @return [Boolean] true if the +<%= element[:name] %>+ element is present on the page
+<%= root %>def <%= element[:name] %>?
+<%= root %>  <%= generation_message %>.
+<%= root %>end
+
+<% end %>
+<% endings = [] %>
+<% modules.size.times do |indent| %>
+<% endings << "#{('  ' * indent)}end" %>
+<% end %>
+<%= endings.reverse.join("\n") %>