tailwindui_rails 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: c66068b76407906b0e629e094f3c9925ab3130560e3389c75b40ff6a79d85ad2
4
+ data.tar.gz: bc64e0db5b5f39b4a915aecd7aecdcae6141e11d976e335d53afbe2034c2bd63
5
+ SHA512:
6
+ metadata.gz: 7972cee30083ee2f66a44c3cc2b909d158a0a45160e57164dd43afcf672ef3a81ea800c820709853644336cc62f5ce637f98a6049615ff4ea33c230a441a4aa3
7
+ data.tar.gz: 2808faaa7fe77bfa43db85cf6fb91f302ddf921b537cf4de1ae9e2b874f8c1a01f97ed4a6b1e6ae5fbc352bbd569a2cba3b36f5b3b046f236f85543524a6ff1f
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+ .DS_Store
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.3
7
+ before_install: gem install bundler -v 1.17.2
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at =. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in tailwindui_rails.gemspec
6
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,88 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ tailwindui_rails (0.1.0)
5
+ railties (>= 6.0)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ actionpack (6.0.2.2)
11
+ actionview (= 6.0.2.2)
12
+ activesupport (= 6.0.2.2)
13
+ rack (~> 2.0, >= 2.0.8)
14
+ rack-test (>= 0.6.3)
15
+ rails-dom-testing (~> 2.0)
16
+ rails-html-sanitizer (~> 1.0, >= 1.2.0)
17
+ actionview (6.0.2.2)
18
+ activesupport (= 6.0.2.2)
19
+ builder (~> 3.1)
20
+ erubi (~> 1.4)
21
+ rails-dom-testing (~> 2.0)
22
+ rails-html-sanitizer (~> 1.1, >= 1.2.0)
23
+ activesupport (6.0.2.2)
24
+ concurrent-ruby (~> 1.0, >= 1.0.2)
25
+ i18n (>= 0.7, < 2)
26
+ minitest (~> 5.1)
27
+ tzinfo (~> 1.1)
28
+ zeitwerk (~> 2.2)
29
+ builder (3.2.4)
30
+ concurrent-ruby (1.1.6)
31
+ crass (1.0.6)
32
+ diff-lcs (1.3)
33
+ erubi (1.9.0)
34
+ i18n (1.8.2)
35
+ concurrent-ruby (~> 1.0)
36
+ loofah (2.5.0)
37
+ crass (~> 1.0.2)
38
+ nokogiri (>= 1.5.9)
39
+ method_source (1.0.0)
40
+ mini_portile2 (2.4.0)
41
+ minitest (5.14.0)
42
+ nokogiri (1.10.9)
43
+ mini_portile2 (~> 2.4.0)
44
+ rack (2.2.2)
45
+ rack-test (1.1.0)
46
+ rack (>= 1.0, < 3)
47
+ rails-dom-testing (2.0.3)
48
+ activesupport (>= 4.2.0)
49
+ nokogiri (>= 1.6)
50
+ rails-html-sanitizer (1.3.0)
51
+ loofah (~> 2.3)
52
+ railties (6.0.2.2)
53
+ actionpack (= 6.0.2.2)
54
+ activesupport (= 6.0.2.2)
55
+ method_source
56
+ rake (>= 0.8.7)
57
+ thor (>= 0.20.3, < 2.0)
58
+ rake (10.5.0)
59
+ rspec (3.9.0)
60
+ rspec-core (~> 3.9.0)
61
+ rspec-expectations (~> 3.9.0)
62
+ rspec-mocks (~> 3.9.0)
63
+ rspec-core (3.9.2)
64
+ rspec-support (~> 3.9.3)
65
+ rspec-expectations (3.9.1)
66
+ diff-lcs (>= 1.2.0, < 2.0)
67
+ rspec-support (~> 3.9.0)
68
+ rspec-mocks (3.9.1)
69
+ diff-lcs (>= 1.2.0, < 2.0)
70
+ rspec-support (~> 3.9.0)
71
+ rspec-support (3.9.3)
72
+ thor (1.0.1)
73
+ thread_safe (0.3.6)
74
+ tzinfo (1.2.7)
75
+ thread_safe (~> 0.1)
76
+ zeitwerk (2.3.0)
77
+
78
+ PLATFORMS
79
+ ruby
80
+
81
+ DEPENDENCIES
82
+ bundler (~> 1.17)
83
+ rake (~> 10.0)
84
+ rspec (~> 3.0)
85
+ tailwindui_rails!
86
+
87
+ BUNDLED WITH
88
+ 1.17.2
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2020 Jeff Scholen
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # TailwinduiRails
2
+
3
+ This gem is built to allow easy start of a Rails 6 project to use TailwindUI components. This is currently only a set of generators to do the mundane work to setting up Rails 6 with TailwindUI. There are no components loaded within this gem. A license must be purchased from tailwindui.com.
4
+
5
+ This gem is heavily influence from [tailwindcss-rails](https://github.com/IcaliaLabs/tailwindcss-rails).
6
+
7
+ ## Installation
8
+
9
+ This has not been tested with versions of Rails earlier than 6. Since webpacker is not installed with earlier versions, you may be able to install this gem with the webpacker gem in addition to the following instructions..
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ ```ruby
14
+ gem 'tailwindui_rails'
15
+ ```
16
+
17
+ And then execute:
18
+
19
+ $ bundle
20
+
21
+ $ bundle exec rails g tailwindui_rails:install
22
+
23
+ The above install command will perform the following task:
24
+
25
+ 1. Add tailwindcss and @tailwind/ui with `yarn`
26
+ 2. Initialize tailwindcss and update the tailwind config file for use with TailwindUI components.
27
+ 3. Update the application layout page for use with alpine js recommended from tailwindUI docs.
28
+ 4. Setup tailwindcss
29
+ 4. Configure postcss config file for use with tailwindcss and tailwindui components.
30
+
31
+ ## Contributing
32
+
33
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tailwindui_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
34
+
35
+ ## License
36
+
37
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
38
+
39
+ ## Code of Conduct
40
+
41
+ Everyone interacting in the TailwinduiRails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tailwindui_rails/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "tailwindui_rails"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'rails/generators/base'
4
+
5
+ module TailwinduiRails
6
+ module Generators
7
+ class InstallGenerator < Rails::Generators::Base
8
+ source_root File.expand_path("../../templates", __FILE__)
9
+
10
+ def yarn_add_tailwindcss_and_ui
11
+ run "yarn --ignore-engines add tailwindcss@1.4 @tailwindcss/ui --tilde"
12
+ end
13
+
14
+ def init_tailwindcss_and_add_tailwindui
15
+ run "./node_modules/.bin/tailwind init ./tailwind.config.js"
16
+ prepend_to_file "./tailwind.config.js", "const defaultTheme = require('tailwindcss/defaultTheme');\n\n"
17
+ inject_into_file "./tailwind.config.js", "\n fontFamily: {\nsans: ['Inter var', ...defaultTheme.fontFamily.sans],\n}", after: "extend: {"
18
+ inject_into_file "./tailwind.config.js", "\n require('@tailwindcss/ui'),\n", after: "plugins: ["
19
+ end
20
+
21
+ def update_application_layout
22
+ gsub_file "app/views/layouts/application.html.erb", /stylesheet_link_tag/, "stylesheet_pack_tag"
23
+ inject_into_file "app/views/layouts/application.html.erb", ' <script src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.0.1/dist/alpine.js" defer></script>', after: "<%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>\n"
24
+ end
25
+
26
+ def setup_tailwindcss
27
+ template "tailwind.css", "app/javascript/stylesheets/application.scss"
28
+ append_to_file "app/javascript/packs/application.js", 'import "stylesheets/application.scss"'
29
+ run "rm -rf app/assets/stylesheets/application.css"
30
+ end
31
+
32
+ def configure_postcssrc
33
+ inject_into_file "postcss.config.js", " require('tailwindcss'),\n", after: "require('postcss-import'),\n"
34
+ inject_into_file "postcss.config.js", " require('autoprefixer'),\n", after: "plugins: [\n"
35
+ end
36
+
37
+ def remove_corejs_3
38
+ gsub_file "babel.config.js", /regenerator: true,\n corejs: 3/, "regenerator: true,"
39
+ end
40
+ end
41
+ end
42
+ end
43
+
44
+
45
+
46
+
@@ -0,0 +1,12 @@
1
+ @import url("https://rsms.me/inter/inter.css");
2
+ html {
3
+ font-family: "Inter", sans-serif;
4
+ }
5
+ @supports (font-variation-settings: normal) {
6
+ html {
7
+ font-family: "Inter var", sans-serif;
8
+ }
9
+ }
10
+ @import "tailwindcss/base";
11
+ @import "tailwindcss/components";
12
+ @import "tailwindcss/utilities";
@@ -0,0 +1 @@
1
+ require "tailwindui_rails/version"
@@ -0,0 +1,3 @@
1
+ module TailwinduiRails
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,14 @@
1
+ require "bundler/setup"
2
+ require "tailwindui_rails"
3
+
4
+ RSpec.configure do |config|
5
+ # Enable flags like --only-failures and --next-failure
6
+ config.example_status_persistence_file_path = ".rspec_status"
7
+
8
+ # Disable RSpec exposing methods globally on `Module` and `main`
9
+ config.disable_monkey_patching!
10
+
11
+ config.expect_with :rspec do |c|
12
+ c.syntax = :expect
13
+ end
14
+ end
@@ -0,0 +1,17 @@
1
+ RSpec.describe TailwinduiRails::Generators::InstallGenerator, type: :generator do
2
+
3
+ it "has a version number" do
4
+ expect(TailwinduiRails::VERSION).not_to be nil
5
+ end
6
+
7
+ describe 'generated files' do
8
+ before do
9
+ run_generator
10
+ let(:file) { 'tailwind.config.js' }
11
+ let(:application_layout) { 'app/views/layouts/application.html.erb' }
12
+ end
13
+
14
+ it { expect(file).to be_an_existing_file }
15
+ it { expect(application_layout).to have_file_content('stylesheet_pack_tag') }
16
+ end
17
+ end
@@ -0,0 +1,29 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "tailwindui_rails/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "tailwindui_rails"
8
+ spec.version = TailwinduiRails::VERSION
9
+ spec.authors = ["Jeff Scholen"]
10
+ spec.email = ["jmscholen@gmail.com"]
11
+
12
+ spec.summary = %q{TailwindUI and Rails 6 gem.}
13
+ spec.description = %q{This gem allows you to run a simple command to install Tailwindcss and the necessary components in order to use TailwindUI. This repo contains no TailwindUI components. You must purchase a license from tailwindui.com. }
14
+ spec.homepage = "https://github.com/jmscholen/tailwindui_rails"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
20
+
21
+ spec.files = `git ls-files`.split("\n")
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.17"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+
28
+ spec.add_dependency("railties", ">= 6.0")
29
+ end
metadata ADDED
@@ -0,0 +1,119 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: tailwindui_rails
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Jeff Scholen
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2020-05-03 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.17'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.17'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: railties
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '6.0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '6.0'
69
+ description: 'This gem allows you to run a simple command to install Tailwindcss and
70
+ the necessary components in order to use TailwindUI. This repo contains no TailwindUI
71
+ components. You must purchase a license from tailwindui.com. '
72
+ email:
73
+ - jmscholen@gmail.com
74
+ executables: []
75
+ extensions: []
76
+ extra_rdoc_files: []
77
+ files:
78
+ - ".gitignore"
79
+ - ".rspec"
80
+ - ".travis.yml"
81
+ - CODE_OF_CONDUCT.md
82
+ - Gemfile
83
+ - Gemfile.lock
84
+ - LICENSE.txt
85
+ - README.md
86
+ - Rakefile
87
+ - bin/console
88
+ - bin/setup
89
+ - lib/generators/tailwindui_rails/install_generator.rb
90
+ - lib/generators/templates/tailwind.css
91
+ - lib/tailwindui_rails.rb
92
+ - lib/tailwindui_rails/version.rb
93
+ - spec/spec_helper.rb
94
+ - spec/tailwindui_rails_spec.rb
95
+ - tailwindui_rails.gemspec
96
+ homepage: https://github.com/jmscholen/tailwindui_rails
97
+ licenses:
98
+ - MIT
99
+ metadata: {}
100
+ post_install_message:
101
+ rdoc_options: []
102
+ require_paths:
103
+ - lib
104
+ required_ruby_version: !ruby/object:Gem::Requirement
105
+ requirements:
106
+ - - ">="
107
+ - !ruby/object:Gem::Version
108
+ version: '0'
109
+ required_rubygems_version: !ruby/object:Gem::Requirement
110
+ requirements:
111
+ - - ">="
112
+ - !ruby/object:Gem::Version
113
+ version: '0'
114
+ requirements: []
115
+ rubygems_version: 3.0.3
116
+ signing_key:
117
+ specification_version: 4
118
+ summary: TailwindUI and Rails 6 gem.
119
+ test_files: []