poe-css 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b354fe9096a347a375766d95be283aa4a8bc756
+  data.tar.gz: f5881993fa54ab9a20cb8b59e5d1cc05af2b720f
+SHA512:
+  metadata.gz: ca625c6f6361c2248aaf62df0613c9860722d45b0837e5fe376af61c0fe2ef39c393058840d88a529f71b55b6ad6ca5f72a099ecd908799cab70983ea5324148
+  data.tar.gz: 5fba14481d64fc611b19ef0c5e47c966382a1fb3b7e5b58b45f73b9a8df74266ed566e63706f2299125c76540528d3b1298d83f012fda91b37426dc4c76f6508

data/.gitignore

@@ -0,0 +1,2 @@
+.rubocop-cache
+pkg

data/.rubocop.yml

@@ -0,0 +1,186 @@
+AllCops:
+  CacheRootDirectory: .rubocop-cache
+  TargetRubyVersion: 2.4.2
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+
+Layout/FirstMethodParameterLineBreak:
+  Enabled: true
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Layout/SpaceAroundOperators:
+  AllowForAlignment: false
+
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyleForEmptyBraces: space
+  EnforcedStyle: space
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: true
+  EnforcedStyle: space
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: false
+
+Performance/Count:
+  SafeMode: false
+
+Performance/Detect:
+  SafeMode: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/AutoResourceCleanup:
+  Enabled: true
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/CollectionMethods:
+  PreferredMethods:
+    detect: find
+
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/InverseMethods:
+  Enabled: false
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/NegatedWhile:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/OptionHash:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/StringMethods:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/TernaryParentheses:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Style/WhileUntilModifier:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change.
+
+Please note we have a code of conduct. Please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+Before merging, ensure that tests are passing (`bundle exec rake`) and that Rubocop is happy (`bundle exec rubocop`). If you are adding new features, please make sure they are tested.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting alexhquach@gmail.com. All complaints will be reviewed
+and investigated and will result in a response that is deemed necessary and
+appropriate to the circumstances. The project team is obligated to maintain
+confidentiality with regard to the reporter of an incident.  Further details of
+specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+ruby '2.4.2'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: .
+  specs:
+    poe-css (0.0.1)
+      parslet
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.3.0)
+    binding.repl (3.0.0)
+    builder (3.2.3)
+    cd (1.0.1)
+    clipboard (1.1.1)
+    code (0.9.2)
+      coderay (~> 1.1)
+      method_source (~> 0.9)
+    coderay (1.1.2)
+    debugging (1.1.1)
+      binding.repl (~> 3.0)
+      paint (>= 0.9, < 3.0)
+    every_day_irb (2.0.0)
+      cd (~> 1.0)
+    fancy_irb (1.1.0)
+      paint (>= 0.9, < 3.0)
+      unicode-display_width (~> 1.1)
+    ffi (1.9.18)
+    hirb (0.7.3)
+    instance (0.2.0)
+    interactive_editor (0.0.10)
+      spoon (>= 0.0.1)
+    irbtools (2.1.0)
+      binding.repl (~> 3.0)
+      clipboard (~> 1.1)
+      code (~> 0.9)
+      coderay (~> 1.1)
+      debugging (~> 1.1)
+      every_day_irb (~> 2.0)
+      fancy_irb (~> 1.1)
+      hirb (~> 0.7, >= 0.7.3)
+      instance (~> 0.2)
+      interactive_editor (~> 0.0, >= 0.0.10)
+      method_locator (~> 0.0, >= 0.0.4)
+      methodfinder (~> 2.0)
+      ori (~> 0.1.0)
+      os (~> 1.0)
+      paint (>= 0.9, < 3.0)
+      ruby_engine (~> 1.0)
+      ruby_info (~> 1.0)
+      ruby_version (~> 1.0)
+      wirb (~> 2.0)
+    method_locator (0.0.4)
+    method_source (0.9.0)
+    methodfinder (2.1.0)
+    minitest (5.10.3)
+    minitest-reporters (1.1.18)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    ori (0.1.0)
+    os (1.0.0)
+    paint (1.0.1)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    parslet (1.8.1)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.52.0)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    ruby_engine (1.0.1)
+    ruby_info (1.0.1)
+    ruby_version (1.0.1)
+    spoon (0.0.6)
+      ffi
+    unicode-display_width (1.3.0)
+    wirb (2.1.1)
+      paint (>= 0.9, < 3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  irbtools
+  minitest
+  minitest-reporters
+  poe-css!
+  rake (~> 10.0)
+  rubocop
+
+RUBY VERSION
+   ruby 2.4.2p198
+
+BUNDLED WITH
+   1.15.3

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alex Quach
+
+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,275 @@
+# PoE CSS
+
+A better way to write item filters for Path of Exile.
+
+Example:
+
+```
+@black: RGB(0, 0, 0)
+@white: RGB(255, 255, 255)
+
+@t1-gem-text-color: RGB(30, 200, 200)
+@t1-gem-border-color: RGB(30, 150, 180)
+@t1-gem-bg-color: @white
+
+@volume: 300
+@t1-drop-sound: 6 @volume
+@unique-drop-sound: 3 @volume
+@value-drop-sound: 2 @volume
+
+@gem-styling() {
+  SetTextColor @t1-gem-text-color
+  SetBorderColor @t1-gem-border-color
+}
+
+Class Gems {
+  Hide
+  SetFontSize 36
+  SetBorderColor @black
+
+  Quality >= 1 {
+    Show
+    SetFontSize 40
+    SetBorderColor @t1-gem-border-color
+  }
+
+  BaseType "Detonate Mines" "Added Chaos Damage" "Vaal" "Enhance" | Quality >= 14 {
+    Show
+    SetFontSize 40
+    @gem-styling()
+    PlayAlertSound @value-drop-sound
+  }
+
+  BaseType "Portal" "Empower" "Enlighten" "Vaal Haste" "Vaal Grace" "Item Quantity" "Vaal Breach" {
+    Show
+    SetFontSize 45
+    @gem-styling()
+    PlayAlertSound @unique-drop-sound
+  }
+}
+```
+
+Via the website or the command line tool, filters written in PoE CSS can be
+transpiled into the native item filter language and plugged right into Path of
+Exile.
+
+### Features
+
+* CSS-style semantics: multiple clauses can match any item, rather than just the first match in the base filter language.
+* Constants
+* Macro expansion
+* Nested and OR matches
+
+## Getting Started
+
+`poe-css` is available online at LINK and as a command line utility. Both
+transform PoE CSS filters into standard item filters that can be plugged into
+Path of Exile. **PoE CSS filters are not directly compatible with Path of Exile**.
+Below are instructions for installing the command line tool.
+
+## Syntax
+
+It's likely easiest to get a sense of the syntax by looking at the example
+above. It should be familiar to anyone comfortable with Path of Exile's item
+filter language as well as people comfortable with CSS/LESS/SASS.
+
+First, everything in PoE CSS is case-insensitive.
+
+A PoE CSS file is a list of clauses. A clause generally looks like this:
+
+```
+<list of matches, comma separated> {
+  <commands>
+}
+```
+
+For example,
+
+```
+ItemLevel >= 25 {
+  Show
+  SetFontSize 16
+}
+```
+
+This clause will style any item whose item level is greater than or equal to
+25. To see all possible conditions and styles, check out the [item filter
+wiki](https://pathofexile.gamepedia.com/Item_filter). It's missing a few new
+matches like ShapedItem though.
+
+**To combine conditions so that all must match, use a comma**:
+
+```
+ItemLevel >= 25, Rarity Unique {
+  Show
+  SetFontSize 24
+}
+```
+
+**Differently from the base item filter language, multiple clauses can match any
+item, just like CSS.** To get an item's final style, PoE CSS finds all clauses
+that match the given item, then combines all of their respective styles. Later
+properties override earlier properties, so later clauses are generally more powerful than earlier clauses.
+
+```
+ItemLevel >= 25 {
+  Show
+  SetFontSize 25
+  SetBackgroundColor RGB(0, 255, 0)
+}
+
+Rarity Unique {
+  Show
+  SetBackgroundColor RGB(255, 0, 0)
+}
+```
+
+ilvl >= 25 items that are not unique will have the font size change and a green
+background. Unique items will have a red background. ilvl >= 25 items that are
+also unique will have the font size change and a red background.
+
+This solves a common pain point with item filters, which is that adding new
+clauses is very difficult and often accidentally overrides later styles.
+
+To match one of many conditions (OR), **use `|`**:
+
+```
+ItemLevel >= 25 | Rarity Unique {
+  Show
+  SetFontSize 24
+}
+```
+
+This is identical to writing it out long form.
+
+```
+ItemLevel >= 25 {
+  Show
+  SetFontSize 24
+}
+
+Rarity Unique {
+  Show
+  SetFontSize 24
+}
+```
+
+**Nested clauses** are considered to be restrictions on the parent clause.
+
+```
+ItemLevel >= 25 {
+  Show
+  SetFontSize 24
+
+  Rarity Unique {
+    Show
+    SetBackgroundColor RGB(255, 0, 0)
+  }
+}
+```
+
+In this filter, items with ilvl >= 25 will have font size 24, and items with ilvl >= 25 and are unique will have a red background color.
+
+Nested clauses are useful when you'd like to work within a certain constraint without repeating yourself.
+
+```
+Class "Bows" {
+  # All clauses in here will only match bows.
+
+  Show
+
+  ItemLevel >= 65 { SetFontSize 13 }
+  ItemLevel >= 70 { SetFontSize 14 }
+  ItemLevel >= 75 { SetFontSize 15 }
+}
+```
+
+You can **define a constant with `@`**. Constants can only be defined once.
+
+```
+@rare-color: RGB(255, 255, 119)
+
+Rarity Rare {
+  SetFontColor @rare-color
+}
+```
+
+Constants are substituted with naive string substitution. This means anything can be made a constant.
+
+```
+@sfc: SetFontColor
+
+Rarity Rare {
+  @sfc RGB(255, 0, 0)
+}
+```
+
+**For multi-line substitutions or substitutions with variables, you can define macros.**
+
+```
+@ilvl-scaled() {
+  ItemLevel >= 65 { Show; SetFontSize 13 }
+  ItemLevel >= 70 { Show; SetFontSize 14 }
+  ItemLevel >= 75 { Show; SetFontSize 15 }
+}
+
+Class "Bows" {
+  Show
+  @ilvl-scaled()
+}
+
+Class "Maces" {
+  Show
+  @ilvl-scaled()
+}
+```
+
+Macros can have arguments:
+
+```
+@hide-under(@ilvl) {
+  ItemLevel < @ilvl {
+    Hide
+  }
+}
+
+Class Shield {
+  @hide-under(25)
+}
+```
+
+Finally, you can write comments with `#`. Anything after `#` and the `#` will be ignored.
+
+## Prerequisites
+
+Ruby >= 2 is necessary to install the command line tool. If you have that, just run `gem install poe-css` and then `poe-css <input file>`.
+
+## Running the tests
+
+`bundle exec rake`
+
+## Built With
+
+* [Parslet](https://kschiess.github.io/parslet/) - Ruby PEG Parser
+
+## Contributing
+
+Please read
+[CONTRIBUTING.md](https://github.com/aquach/poe-css/blob/master/CONTRIBUTING.md)
+for details on our code of conduct, and the process for submitting pull
+  requests to us.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available,
+see the [tags on this repository](https://github.com/aquach/poe-css/tags).
+
+## Authors
+
+* **Alex Quach** - *Initial work* - [aquach](https://github.com/aquach)
+
+See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details