app_rail-steps 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d7ed99205a9e9db659296754d42ef0bcafa75951e48150e3b8188b0a6113537
+  data.tar.gz: 0d5e985126744124848932c161b784e7b3728fa856b427a1f4dd4df1b49fe8ee
+SHA512:
+  metadata.gz: b0ec5fbc16e24c054f2d82fba4649bca355e64acd8b2ae08b6ff08c38234cc1983a0d19b02c375c71a42e0e256af5d12ed061101ee31d1eb8a46e1ecc800b076
+  data.tar.gz: 2300ca3ed13267800e9e463abb4f7ea345800b475c2eed25e9f3f331640af86c04d7cc4c0f4abf3609d89f9b5b350b8fb60313f7d16c8676d47ece5d27c4f919

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-12
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in app_rail-steps.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Matt Brooke-Smith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# AppRail::Steps
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/app_rail/steps`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'app_rail-steps'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install app_rail-steps
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/app_rail-steps.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/app_rail-steps.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/app_rail/steps/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "app_rail-steps"
+  spec.version = AppRail::Steps::VERSION
+  spec.authors = ["Matt Brooke-Smith"]
+  spec.email = ["matt@futureworkshops.com"]
+
+  spec.summary = "Utilities to generate JSON for expected step responses."
+  spec.homepage = "https://github.com/FutureWorkshops/app_rail-steps"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/FutureWorkshops/app_rail-steps"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/app_rail/steps/core/list.rb

@@ -0,0 +1,15 @@
+module AppRail
+  module Steps
+    module Core
+      module List
+        def ar_core_list_item(id: self.id, text:, detail_text: nil, sf_symbol_name: nil, material_icon_name: nil, preview_url: nil)
+          { id: id, text: text, detailText: detail_text, sfSymbolName: sf_symbol_name, materialIconName: material_icon_name, imageURL: preview_url }.compact
+        end
+        
+        def ar_core_list_search_suggestion(id: self.id, text:, section_name:, sf_symbol_name: nil)
+          {id: id.to_s, text: text, sectionName: section_name, sfSymbolName: sf_symbol_name}.compact
+        end
+      end
+    end
+  end
+end

data/lib/app_rail/steps/displayable.rb

@@ -0,0 +1,29 @@
+require_relative "core/list"
+
+module AppRail
+  module Steps
+    module Displayable
+
+      include Steps::Core::List
+
+      BUTTON_STYLES = [:primary, :outline, :danger, :textOnly]
+      ON_SUCCESS_OPTIONS = [:none, :reload, :backward, :forward]
+    
+      private
+      def validate_on_success!(on_success)
+        raise 'Unknown on_success action' unless ON_SUCCESS_OPTIONS.include?(on_success)
+      end
+    
+      def validate_button_style!(style)
+        raise 'Unknown style' unless BUTTON_STYLES.include?(style)      
+      end
+
+      def camelcase_converter(string, first_letter: :upper)
+        string = string.split("_").map(&:capitalize).join
+        return string unless first_letter == :lower
+
+        string[0].downcase + string[1..-1]
+      end
+    end
+  end
+end

data/lib/app_rail/steps/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AppRail
+  module Steps
+    VERSION = "0.1.0"
+  end
+end

data/lib/app_rail/steps.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "steps/version"
+require_relative "steps/displayable"
+
+module AppRail
+  module Steps
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: app_rail-steps
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Brooke-Smith
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-12 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- matt@futureworkshops.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app_rail-steps.gemspec
+- lib/app_rail/steps.rb
+- lib/app_rail/steps/core/list.rb
+- lib/app_rail/steps/displayable.rb
+- lib/app_rail/steps/version.rb
+homepage: https://github.com/FutureWorkshops/app_rail-steps
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/FutureWorkshops/app_rail-steps
+  source_code_uri: https://github.com/FutureWorkshops/app_rail-steps
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Utilities to generate JSON for expected step responses.
+test_files: []