ruby_styler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc2d2697f71503415f4c55bf9c37c7355c4302b432a9d23d9645601f5043049d
+  data.tar.gz: e3b806e9688d6fdb3610d9f7ab9d86822895c7be0f02ab1f50ec9379689b42d8
+SHA512:
+  metadata.gz: 04a9713884e011cab7c1df484e76ec92155cbf9620b3689d9bfa3de376d492bbed9659436cdc07964cd52ac195e06e8f6c0a2c5b5bdca7cc2008233235e858a0
+  data.tar.gz: 549b2c02f204d3b5cf898564c2dbb016f8e835ef5077407ac71973582f4c557a7dc71457411c32a5849ae2f16681d4f36f4891b3ace0df38466c424345d182de

data/README.md

@@ -0,0 +1,333 @@
+# Styler
+
+A tool for styling html by composing css utility classes, like Tachyons.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ruby_styler"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby_styler
+
+## Usage
+
+### Define styles
+
+You can declare styles with a name and an already defined css class, for example if you define a `style`
+named `btn`, like this...
+
+```ruby
+styles = Styler.new do
+  style :btn, ["white", "bg_blue"]
+end
+```
+
+That will build and `styles` object where you can call `btn` on it...
+
+```ruby
+styles.btn.to_s # => "white bg_blue"
+```
+
+You would be able to use it like this in your erb files...
+
+```erb
+<button class="<%= styles.btn %>">My button</button>
+```
+
+or in haml...
+
+```haml
+%button{class: styles.btn} My button
+```
+
+To output...
+
+```html
+<button class="white bg_blue">My button</button>
+```
+
+### Compose styles
+
+You can define many of this styles and compose them...
+
+```ruby
+styles = Styler.new do
+  style :btn, ["padding3", "margin3"]
+  style :blue_btn, [btn, "white", "bg_blue"]
+end
+```
+
+```haml
+%button{class: styles.btn} My button
+%button{class: styles.blue_btn} My button
+```
+
+And the output would be...
+
+```html
+<button class="padding3 margin3">My button</button>
+<button class="padding3 margin3 white bg_blue">My button</button>
+```
+
+### Substract styles
+
+By composing your styles you can also substract classes from previous styles, like this...
+
+```ruby
+styles = Styler.new do
+  style :default, ["pa3", "white", "bg_blue"]
+  style :danger, [default - "bg_blue", "bg_red"]
+end
+
+styles.default.to_s # => "pa3 white bg_blue"
+styles.danger.to_s # => "pa3 white bg_red"
+```
+
+### Passing arguments to styles
+
+You can also define styles that expect an argument, to help you decide which styles to display, like this...
+
+```ruby
+styles = Styler.new do
+  style :default_color do |project|
+    if project[:color] == "blue"
+      ["bg_blue"]
+    else
+      ["bg_red"]
+    end
+  end
+end
+
+project = { color: "blue" }
+styles.default_color(project).to_s # => "bg_blue"
+```
+
+And you can use this styles to build other styles, like this...
+
+```ruby
+project = { color: "blue" }
+
+styles = Styler.new do
+  style :default_color do |project|
+    if project[:color] == "blue"
+      ["bg_blue"]
+    else
+      ["bg_red"]
+    end
+  end
+
+  style :title, [default_color(project), "pa3"]
+end
+
+styles.title(project).to_s # => "bg_blue pa3"
+```
+
+Or like this...
+
+```ruby
+styles = Styler.new do
+  style :default_color do |project|
+    if project[:color] == "blue"
+      ["bg_blue"]
+    else
+      ["bg_red"]
+    end
+  end
+
+  style :title do |project|
+    [default_color(project), "pa3"]
+  end
+end
+
+project = { color: "blue" }
+styles.title(project).to_s # => "bg_blue pa3"
+```
+
+### Define collections
+
+You can define collections as "namespaces" for your styles...
+
+```ruby
+styles = Styler.new do
+  collection :buttons do
+    style :default, ["pa3", "blue"]
+    style :danger, [default - "blue", "red"]
+  end
+end
+
+styles.respond_to?(:default) # => false
+styles.respond_to?(:danger) # => false
+styles.buttons.default.to_s # => "pa3 blue"
+styles.buttons.danger.to_s # => "pa3 red"
+```
+
+### Nested collections
+
+You can define nested collections to build complete themes...
+
+```ruby
+styles = Styler.new do
+  collection :v1 do
+    collection :buttons do
+      style :default, ["pa3", "blue"]
+    end
+  end
+
+  collection :v2 do
+    collection :buttons do
+      style :default, ["pa3", "red"]
+    end
+  end
+end
+
+styles.v1.buttons.default.to_s # => "pa3 blue"
+styles.v2.buttons.default.to_s # => "pa3 red"
+```
+
+### Define collection with arguments
+
+Like with the styles, you can define collections that require arguments, like this..
+
+```ruby
+styles = Styler.new do
+  collection :buttons do |project|
+    if project[:color] == "blue"
+      style :default, ["pa3", "blue"]
+    else
+      style :default, ["pa3", "red"]
+    end
+  end
+end
+
+project = { color: "blue" }
+styles.buttons(project).default.to_s # => "pa3 blue"
+```
+
+### Select a collection with an alias
+
+```ruby
+styles = Styler.new do
+  collection :v1 do
+    collection :buttons do
+      style :default, ["pa3", "blue"]
+    end
+  end
+
+  collection :v2 do
+    collection :buttons do
+      style :default, ["pa3", "red"]
+    end
+  end
+
+  collection_alias :theme, v1
+end
+
+styles.theme.buttons.default.to_s # => "pa3 blue"
+```
+
+### Collection alias with a block
+
+```ruby
+styles = Styler.new do
+  collection :v1 do
+    collection :buttons do
+      style :default, ["pa3", "blue"]
+    end
+  end
+
+  collection :v2 do
+    collection :buttons do
+      style :default, ["pa3", "red"]
+    end
+  end
+
+  collection_alias :theme do |current_version|
+    if current_version == "v1"
+      v1
+    else
+      v2
+    end
+  end
+end
+
+styles.theme("v1").buttons.default.to_s # => "pa3 blue"
+styles.theme("v2").buttons.default.to_s # => "pa3 red"
+```
+
+### Select a collection from other styler
+
+```ruby
+v1 = Styler.new do
+  collection :buttons do
+    style :default, ["pa3", "blue"]
+  end
+end
+
+v2 = Styler.new do
+  collection :buttons do
+    style :default, ["pa3", "red"]
+  end
+end
+
+styles = Styler.new do
+  collection_alias :theme do |current_version|
+    if current_version == "v1"
+      v1
+    else
+      v2
+    end
+  end
+end
+
+styler.theme("v1").buttons.default.to_s # => "pa3 blue"
+styler.theme("v2").buttons.default.to_s # => "pa3 red"
+```
+
+### Copy styles from collection
+
+If you need to use the styles from other collection, but you need to override
+some of them, you can copy the styles and then override what you want.
+
+```ruby
+styles = Styler.new do
+  collection :v1 do
+    collection :buttons do
+      style :default, ["pa3", "blue"]
+      style :danger, [default - "blue", "red"]
+    end
+  end
+
+  collection :v2 do
+    collection :buttons do
+      copy_styles_from collection: v1.buttons
+      style :danger, [v1.buttons.danger - "red", "orange"]
+    end
+  end
+end
+
+expect(styles.v2.buttons.default.to_s).to eq "pa3 blue"
+expect(styles.v2.buttons.danger.to_s).to eq "pa3 orange"
+```
+
+## 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/bhserna/styler.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/styler/collection.rb

@@ -0,0 +1,91 @@
+class Styler::Collection < SimpleDelegator
+  attr_reader :parent, :name, :style_names, :collection_names
+
+  def initialize(parent = nil, name = :default)
+    super(parent) if parent
+    @parent = parent
+    @name = name
+    @style_names = []
+    @collection_names = []
+  end
+
+  def ==(other)
+    self.class == other.class && name == other.name
+  end
+
+  def style(name, styles = nil, &block)
+    @style_names << name
+
+    if styles
+      define_singleton_method(name) do |*args|
+        Styler::Style.new(self, name, styles)
+      end
+    else
+      define_singleton_method(name) do |*args|
+        styles = instance_exec(*args, &block)
+        Styler::Style.new(self, name, styles)
+      end
+    end
+  end
+
+  def collection(name, &block)
+    @collection_names << name
+
+    define_singleton_method(name) do |*args|
+      self.class.new(self, name).tap do |c|
+        c.instance_exec(*args, &block)
+      end
+    end
+  end
+
+  def collection_alias(name, collection = nil, &block)
+    @collection_names << name
+
+    define_singleton_method(name) do |*args|
+      if collection
+        collection
+      else
+        instance_exec(*args, &block)
+      end
+    end
+  end
+
+  def copy_styles_from(collection:)
+    collection.styles.each do |style|
+      style(style.name, style.to_a)
+    end
+  end
+
+  def path
+    return "root" if parent.nil?
+    "#{parent.path}.#{name}"
+  end
+
+  def repeted_styles
+    nested_styles
+      .group_by(&:to_a)
+      .select { |_, styles| styles.count > 1 }
+      .to_h
+      .values
+  end
+
+  def styles
+    style_names.map { |name| send(name) }
+  end
+
+  def collections
+    collection_names.map { |name| send(name) }
+  end
+
+  def nested_styles
+    styles + nested_collections.flat_map(&:styles)
+  end
+
+  def nested_collections
+    if collections.empty?
+      []
+    else
+      collections + collections.flat_map(&:nested_collections)
+    end
+  end
+end

data/lib/styler/style.rb

@@ -0,0 +1,27 @@
+class Styler::Style
+  attr_reader :collection, :name, :styles
+
+  def initialize(collection, name, styles = [])
+    @collection = collection
+    @name = name
+    @styles = styles
+  end
+
+  def ==(other)
+    self.class == other.class &&
+      name == other.name &&
+      to_a == other.to_a
+  end
+
+  def -(other)
+    Styler::StyleSubstraction.new(self, other)
+  end
+
+  def to_a
+    styles.map(&:to_s)
+  end
+
+  def to_s
+    to_a.join(" ")
+  end
+end

data/lib/styler/style_substraction.rb

@@ -0,0 +1,23 @@
+class Styler::StyleSubstraction
+  attr_reader :a, :b
+
+  def initialize(a, b)
+    @a, @b = a, b
+  end
+
+  def -(other)
+    self.class.new(self, other)
+  end
+
+  def to_a
+    if b.is_a? String
+      a.to_a - [b.to_s]
+    else
+      a.to_a - b.to_a
+    end
+  end
+
+  def to_s
+    to_a.join(" ")
+  end
+end

data/lib/styler/version.rb

@@ -0,0 +1,3 @@
+module Styler
+  VERSION = "0.1.0"
+end

data/lib/styler.rb

@@ -0,0 +1,15 @@
+require "delegate"
+
+require "styler/version"
+
+require "styler/collection"
+require "styler/style"
+require "styler/style_substraction"
+
+module Styler
+  def self.new(&block)
+    Collection.new.tap do |c|
+      c.instance_eval(&block)
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: ruby_styler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benito Horacio Serna Sandoval
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- bhserna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/styler.rb
+- lib/styler/collection.rb
+- lib/styler/style.rb
+- lib/styler/style_substraction.rb
+- lib/styler/version.rb
+homepage: https://github.com/bhserna/styler
+licenses:
+- MIT
+metadata: {}
+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.2.3
+signing_key:
+specification_version: 4
+summary: A tool for styling html by composing css utility classes
+test_files: []