lookbook_storybook_json_generator 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: babe0884a77140c8d7cc84ba17cb0f55e0cfafc6d07ce5327477fe2a1972ed00
4
+ data.tar.gz: a09c553d2f901371aa2773cb634d40eca08c2504b5d8d9629355858ee06d15b4
5
+ SHA512:
6
+ metadata.gz: fc3ed8a22ac5983b81de12fb8dbeb5de9faa98542ee6b8ff9b823981328f72414adbf6ccb5f0cf91f43c4c1578bfe32d50c65973c5d3837782594c9a54ee5bf9
7
+ data.tar.gz: 06edb1028589a39b07cda734805a4a94973f7d851f68cedb5b66e5c7365119ca38cd350b29217aaed7db95831736f522991a3146d61f751a60df97838e43ad17
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,34 @@
1
+ require:
2
+ - rubocop-rspec
3
+
4
+ AllCops:
5
+ TargetRubyVersion: 3.2
6
+ NewCops: enable
7
+ SuggestExtensions: false
8
+
9
+ Exclude:
10
+ - "bin/**/*"
11
+
12
+ Naming/VariableNumber:
13
+ Enabled: false
14
+
15
+ RSpec/NamedSubject:
16
+ Enabled: false
17
+
18
+ RSpec/MultipleExpectations:
19
+ Enabled: false
20
+
21
+ RSpec/ExampleLength:
22
+ Enabled: false
23
+
24
+ RSpec/IndexedLet:
25
+ Enabled: false
26
+
27
+ RSpec/MultipleMemoizedHelpers:
28
+ Enabled: false
29
+
30
+ RSpec/NestedGroups:
31
+ Enabled: false
32
+
33
+ RSpec/ExpectChange:
34
+ Enabled: false
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.0] - 2024-01-14
4
+
5
+ - Initial release
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tokunaga.c.daigo@forgxisto.com. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2024 ikad
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,36 @@
1
+ # LookbookStorybookJsonGenerator
2
+
3
+ This is a gem that allows you to use lookbook with storybook.
4
+ It outputs JSON that can be used with storybook.
5
+
6
+ ## Installation
7
+
8
+ Install the gem and add to the application's Gemfile by executing:
9
+
10
+ $ bundle add lookbook_storybook_json_generator
11
+
12
+ If bundler is not being used to manage dependencies, install the gem by executing:
13
+
14
+ $ gem install lookbook_storybook_json_generator
15
+
16
+ ## Usage
17
+
18
+ TODO: Write usage instructions here
19
+
20
+ ## Development
21
+
22
+ 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.
23
+
24
+ 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).
25
+
26
+ ## Contributing
27
+
28
+ Bug reports and pull requests are welcome on GitHub at https://github.com/forgxisto/lookbook_storybook_json_generator. 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/forgxisto/lookbook_storybook_json_generator/blob/master/CODE_OF_CONDUCT.md).
29
+
30
+ ## License
31
+
32
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
33
+
34
+ ## Code of Conduct
35
+
36
+ Everyone interacting in the LookbookStorybookJsonGenerator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/forgxisto/lookbook_storybook_json_generator/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'bundler/gem_tasks'
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require 'rubocop/rake_task'
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ task default: %i[spec rubocop]
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module LookbookStorybookJsonGenerator
4
+ # lookbookのコードオブジェクトをパースして、storybookのjsonに変換する
5
+ class LookbookCodeObjectParser
6
+ def initialize(code_object)
7
+ @code_object = code_object
8
+ end
9
+
10
+ def to_json(*_args)
11
+ JSON.pretty_generate(
12
+ {
13
+ title:,
14
+ stories:
15
+ }
16
+ )
17
+ end
18
+
19
+ private
20
+
21
+ attr_reader :code_object
22
+
23
+ def title
24
+ code_object.namespace.title.gsub(code_object.namespace.sep, '/')
25
+ end
26
+
27
+ def stories
28
+ code_object.meths.map { story(_1) }
29
+ end
30
+
31
+ def story(meth)
32
+ {
33
+ name: meth.name,
34
+ parameters: parameters(meth),
35
+ args: args(meth),
36
+ argTypes: arg_types(meth)
37
+ }
38
+ end
39
+
40
+ def parameters(meth)
41
+ { server: { id: "#{title.underscore}/#{meth.name}" } }
42
+ end
43
+
44
+ def args(meth)
45
+ meth.parameters.each_with_object({}) do |(k, v), a|
46
+ key = k.delete(':').to_sym
47
+ # 値から引用符を削除し、シンボルがあれば文字列に変換
48
+ val = v.gsub(/'|"/, '').then { _1.start_with?(':') ? _1[1..] : _1 }
49
+
50
+ a[key] = val
51
+ end
52
+ end
53
+
54
+ def arg_types(meth)
55
+ meth.tags.each_with_object({}) do |e, a|
56
+ a[e.name] = {
57
+ control: { type: control_type(e.tag_args[:input]) },
58
+ name: e.name.camelcase,
59
+ options: type_options(e.tag_args[:rest])
60
+ }
61
+ end
62
+ end
63
+
64
+ def control_type(input)
65
+ case input
66
+ when 'toggle'
67
+ 'boolean'
68
+ when 'number'
69
+ 'number'
70
+ else
71
+ 'text'
72
+ end
73
+ end
74
+
75
+ def type_options(rest)
76
+ case rest
77
+ when /choices: \[(.+)\]/
78
+ ::Regexp.last_match(1).split(',').map(&:strip)
79
+ else
80
+ []
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module LookbookStorybookJsonGenerator
4
+ # lookbook のコードオブジェクトを storybook の json として出力する
5
+ class StorybookJsonGenerator
6
+ def self.execute(code_objects, _args)
7
+ code_objects.each do |code_object|
8
+ # code_object と同じ場所にファイルを作成する
9
+ # ただし、ファイル名は .stories.json とする
10
+ file_name = code_object.file.to_s.gsub('.rb', '.stories.json')
11
+ json = LookbookStorybookJsonGenerator::LookbookCodeObjectParser.new(code_object).to_json
12
+ File.open(file_name, 'w') { _1.puts json }
13
+ end
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module LookbookStorybookJsonGenerator
4
+ VERSION = '0.1.0'
5
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'lookbook'
4
+ require_relative 'lookbook_storybook_json_generator/version'
5
+ require_relative 'lookbook_storybook_json_generator/storybook_json_generator'
6
+ require_relative 'lookbook_storybook_json_generator/lookbook_code_object_parser'
7
+
8
+ # Lookbook::PreviewCollection の load メソッドをオーバーライドする
9
+ module LookbookStorybookJsonGenerator
10
+ def load(...)
11
+ super(...)
12
+ StorybookJsonGenerator.execute(...)
13
+ end
14
+ end
15
+
16
+ Lookbook::PreviewCollection.prepend(LookbookStorybookJsonGenerator)
@@ -0,0 +1,33 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'lib/lookbook_storybook_json_generator/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'lookbook_storybook_json_generator'
7
+ spec.version = LookbookStorybookJsonGenerator::VERSION
8
+ spec.authors = ['ikad']
9
+ spec.email = ['tokunaga.c.daigo@forgxisto.com']
10
+
11
+ spec.summary = 'Generates JSON for Storybook from Lookbook'
12
+ spec.description = 'Generates JSON for Storybook from Lookbook.'
13
+ spec.homepage = 'https://github.com/forgxisto/lookbook_storybook_json_generator'
14
+ spec.license = 'MIT'
15
+ spec.required_ruby_version = '>= 3.2.0'
16
+
17
+ spec.metadata['homepage_uri'] = spec.homepage
18
+ spec.metadata['source_code_uri'] = 'https://github.com/forgxisto/lookbook_storybook_json_generator'
19
+ spec.metadata['changelog_uri'] = 'https://github.com/forgxisto/lookbook_storybook_json_generator'
20
+
21
+ spec.files = Dir.chdir(__dir__) do
22
+ `git ls-files -z`.split("\x0").reject do |f|
23
+ (File.expand_path(f) == __FILE__) ||
24
+ f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
25
+ end
26
+ end
27
+ spec.bindir = 'exe'
28
+ spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
29
+ spec.require_paths = ['lib']
30
+
31
+ spec.add_dependency 'lookbook', '~> 2.1.1'
32
+ spec.metadata['rubygems_mfa_required'] = 'true'
33
+ end
@@ -0,0 +1,4 @@
1
+ module LookbookStorybookJsonGenerator
2
+ VERSION: String
3
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ end
metadata ADDED
@@ -0,0 +1,74 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: lookbook_storybook_json_generator
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - ikad
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2024-01-14 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: lookbook
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 2.1.1
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 2.1.1
27
+ description: Generates JSON for Storybook from Lookbook.
28
+ email:
29
+ - tokunaga.c.daigo@forgxisto.com
30
+ executables: []
31
+ extensions: []
32
+ extra_rdoc_files: []
33
+ files:
34
+ - ".rspec"
35
+ - ".rubocop.yml"
36
+ - CHANGELOG.md
37
+ - CODE_OF_CONDUCT.md
38
+ - LICENSE.txt
39
+ - README.md
40
+ - Rakefile
41
+ - lib/lookbook_storybook_json_generator.rb
42
+ - lib/lookbook_storybook_json_generator/lookbook_code_object_parser.rb
43
+ - lib/lookbook_storybook_json_generator/storybook_json_generator.rb
44
+ - lib/lookbook_storybook_json_generator/version.rb
45
+ - lookbook_storybook_json_generator.gemspec
46
+ - sig/lookbook_storybook_json_generator.rbs
47
+ homepage: https://github.com/forgxisto/lookbook_storybook_json_generator
48
+ licenses:
49
+ - MIT
50
+ metadata:
51
+ homepage_uri: https://github.com/forgxisto/lookbook_storybook_json_generator
52
+ source_code_uri: https://github.com/forgxisto/lookbook_storybook_json_generator
53
+ changelog_uri: https://github.com/forgxisto/lookbook_storybook_json_generator
54
+ rubygems_mfa_required: 'true'
55
+ post_install_message:
56
+ rdoc_options: []
57
+ require_paths:
58
+ - lib
59
+ required_ruby_version: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - ">="
62
+ - !ruby/object:Gem::Version
63
+ version: 3.2.0
64
+ required_rubygems_version: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ requirements: []
70
+ rubygems_version: 3.4.17
71
+ signing_key:
72
+ specification_version: 4
73
+ summary: Generates JSON for Storybook from Lookbook
74
+ test_files: []