maplibre-preview 0.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c53c9beaf557d2515e3fa6a87ac6f95a99ba975f92f77643538c085c3ce370c6
-  data.tar.gz: c040357000228732ca22c149a208342574d94b8aa747bfe0c7ccb4ccf306371d
+  metadata.gz: 5eb134207de2f2a8569ae8cfed678aa2fff2bf1830445b1fcfbc91aa7425a31b
+  data.tar.gz: fe069e3cee94b2be2ccbca438b900829feb1e1bdbfa0f3223dacafde8f7d813f
 SHA512:
-  metadata.gz: 9c23a2ad06133ecaffe22d875dc64a47a4312a29104abcc7b3fc04fba28964f9bceffc34773b9bd7046f8d2348d94ff0590f6e08591e66f8674d0d5e81c3e3d3
-  data.tar.gz: dbff948c6f81472b01d06ec037c442c58738b1c5ea1b00aedc772b66b0e149a12ca18fdb31e915edc5d2d3c28a37d2e20c5330e6d733d06a11e00e518fad951a
+  metadata.gz: ff02d878106be03c989ceff9851832c2d42a3745b338ffc8491b47b7694a81f48632eb87211bb82d73306d8d5ba959b10b61ed0abd982c8d70307544aff98995
+  data.tar.gz: aca536c781206ce0d75234aa924e663429db495c84478b5742aa1074699bc2618aab48f34236006eb694c9599f3f52bf5b299e17751eb83ba2575bd266f738a9

data/.github/workflows/release.yml

@@ -0,0 +1,16 @@
+on: { push: { branches: [master,main] } }
+
+jobs:
+  build_and_publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with: { ruby-version: '3.3.1' }
+      - run: |
+          mkdir -p ~/.gem && touch ~/.gem/credentials && chmod 0600 ~/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${API_KEY}\n" > ~/.gem/credentials
+          bundle install && rake push
+        env:
+          API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          GITHUB_RUN_NUMBER: ${{ github.run_number }}

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--warnings

data/.rubocop.yml

@@ -0,0 +1,260 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  # TargetRubyVersion: 3.1.2 read from .ruby-version
+  NewCops: enable
+  Exclude:
+    - benchmarks/*.rb
+    - "*.gemspec"
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - "spec/**/*.rb"
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: true
+  # because 'expect { foo }.to change { bar }' is fine
+  Exclude:
+    - "spec/**/*.rb"
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - "spec/**/*.rb"
+
+Lint/RaiseException:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: false
+
+Lint/SuppressedException:
+  Exclude:
+    - "spec/spec_helper.rb"
+
+Lint/LiteralAsCondition:
+  Exclude:
+    - "spec/**/*.rb"
+
+Naming/PredicateName:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - "lib/*-*.rb"
+
+Naming/MethodName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 12
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - "spec/**/*.rb"
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/DateTime:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/StabbyLambdaParentheses:
+  Enabled: false
+
+#Style/StringLiterals:
+#  Enabled: true
+#  EnforcedStyle: double_quotes
+#  ConsistentQuotesInMultiline: false
+#
+#Style/StringLiteralsInInterpolation:
+#  Enabled: true
+#  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Exclude:
+    - "spec/**/*.rb"
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+Style/MultipleComparison:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/EmptyLiteral:
+  Enabled: false
+
+Style/Semicolon:
+  Exclude:
+    - "spec/**/*.rb"
+
+Style/HashAsLastArrayItem:
+  Exclude:
+    - "spec/**/*.rb"
+
+Style/CaseEquality:
+  Exclude:
+    - "lib/dry/monads/**/*.rb"
+    - "lib/dry/struct/**/*.rb"
+    - "lib/dry/types/**/*.rb"
+    - "spec/**/*.rb"
+
+Style/ExplicitBlockArgument:
+  Exclude:
+    - "lib/dry/types/**/*.rb"
+
+Style/CombinableLoops:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumberedParametersLimit:
+  Max: 2
+
+Lint/UnusedBlockArgument:
+  Exclude:
+    - "spec/**/*.rb"
+
+Lint/Debugger:
+  Exclude:
+    - "bin/console"
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/ParameterLists:
+  Exclude:
+    - "spec/**/*.rb"
+
+Lint/EmptyBlock:
+  Exclude:
+    - "spec/**/*.rb"
+
+Lint/UselessMethodDefinition:
+  Exclude:
+    - "spec/**/*.rb"
+
+Lint/SelfAssignment:
+  Enabled: false
+
+Lint/EmptyClass:
+  Enabled: false
+
+Naming/ConstantName:
+  Exclude:
+    - "spec/**/*.rb"
+
+Naming/VariableNumber:
+  Exclude:
+    - "spec/**/*.rb"
+
+Naming/BinaryOperatorParameterName:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.4.4

data/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+## [1.1.0] - 2025-10-01
+
+### Refactored
+- **Simplified architecture** with streamlined Sinatra extension pattern
+- **Consolidated code** into single `lib/maplibre-preview.rb` file
+- **Removed helper methods** in favor of direct Slim template calls
+- **Updated template names** to `maplibre_map` and `maplibre_layout` to avoid conflicts
+- **Streamlined Sinatra extension** with prepend modules for static assets and templates
+
+### Technical Changes
+- **Removed StaticMiddleware** in favor of prepend-based static asset serving
+- **Removed Helpers module** with helper methods
+- **Direct route integration** using `slim :maplibre_map, layout: :maplibre_layout`
+- **Simplified file structure** with all core functionality in main file
+- **Improved template resolution** using `__dir__` context for gem paths
+
+## [1.0.0] - 2025-09-29
+
+### Added
+- **Extracted MapLibre development tools** from existing tiles-proxy-cache project
+- **Sinatra extension** for easy integration into existing applications
+- **StaticMiddleware** for serving gem assets (JS files) without conflicts
+- **Helper methods** for rendering map development interface
+- **Standalone application** for testing and development purposes
+
+### Extracted Features
+- **Advanced layer filtering** with metadata support (from `filters.js`)
+- **Terrain visualization** and elevation profiles (from `contour.js`)
+- **Performance monitoring** and metrics display
+- **Interactive style debugging** tools
+- **Contour line generation** for terrain data using MapLibre Contour
+- **Hover and click modes** for feature inspection
+- **MapLibre GL JS integration** with version 5.7.3
+
+### Refactored Components
+- **Slim templates** (`map.slim`, `map_layout.slim`) adapted for gem structure
+- **JavaScript modules** (`filters.js`, `contour.js`) preserved with original functionality
+- **View rendering** with dynamic path resolution for gem integration
+- **Configuration system** with sensible defaults for MapLibre development
+
+### Technical Implementation
+- **Ruby >= 2.7.0** support with modern gem structure
+- **Sinatra 2.1+** compatibility and extension system
+- **Rack middleware** for asset serving without path conflicts
+- **Comprehensive test suite** with RSpec for all components
+- **Clean gem structure** optimized for integration use cases
+
+### Migration Notes
+This gem extracts the MapLibre development tools that were previously embedded in the tiles-proxy-cache project, making them reusable across different Sinatra applications. The original functionality has been preserved while adding proper gem structure and integration capabilities.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alexandr Ludov
+
+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,312 @@
+# MapLibre Preview
+
+A Ruby gem providing development tools for MapLibre GL JS styles with advanced filtering, terrain visualization, and performance monitoring capabilities. Designed for seamless integration into Sinatra applications.
+
+[![Ruby](https://img.shields.io/badge/ruby-2.7+-red.svg)](https://ruby-lang.org)
+[![Sinatra](https://img.shields.io/badge/sinatra-web_framework-lightgrey.svg)](http://sinatrarb.com/)
+[![MapLibre](https://img.shields.io/badge/maplibre-gl_js-blue.svg)](https://maplibre.org/)
+[![Русский](https://img.shields.io/badge/русский-документация-orange.svg)](docs/README_RU.md)
+
+## Key Features
+
+- **Advanced Layer Filtering**: Metadata-driven layer filtering with support for complex filter expressions
+- **Terrain Visualization**: Full terrain support with elevation profiles and contour line generation
+- **Performance Monitoring**: Real-time FPS, memory usage, and tile loading metrics
+- **Interactive Debugging**: Hover and click modes for feature inspection
+- **Sinatra Integration**: Seamless integration as Sinatra extension with helper methods
+- **Static Asset Serving**: Built-in middleware for serving JavaScript modules without conflicts
+
+## Architecture Overview
+
+The gem consists of several integrated components:
+
+### Core Components
+
+- **[Main Module](lib/maplibre-preview.rb)** - Core gem functionality including Sinatra extension, Rack middleware, helper methods, and standalone application
+- **[Slim Templates](lib/maplibre-preview/views/)** - HTML templates for map interface
+- **[JavaScript Modules](lib/maplibre-preview/public/js/)** - Client-side filtering and terrain logic
+
+### Data Flow
+
+1. **Sinatra Integration** → Register extension → Configure options → Use helpers
+2. **Asset Serving** → StaticMiddleware intercepts `/js/*` requests → Serves from gem
+3. **Map Rendering** → Helper methods render Slim templates → Include external dependencies
+4. **Client Interaction** → JavaScript modules handle filtering and terrain features
+
+## Quick Start
+
+### Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'maplibre-preview'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+### Basic Integration
+
+```ruby
+require 'maplibre-preview'
+
+class MyApp < Sinatra::Base
+  register MapLibrePreview::Extension
+  
+  get '/map' do
+    slim :maplibre_map, layout: :maplibre_layout
+  end
+end
+```
+
+### Passing Style URL
+
+There are several ways to pass a style URL to the map:
+
+**1. Via URL parameter:**
+```
+http://localhost:9292/map?style_url=https://example.com/style.json
+```
+
+**2. Via route parameter:**
+```ruby
+get '/map' do
+  params[:style_url] = 'https://example.com/style.json'
+  slim :maplibre_map, layout: :maplibre_layout
+end
+```
+
+**3. Via source parameter:**
+```
+http://localhost:9292/map?source=Example_Style
+```
+
+### Standalone Development Server
+
+The gem includes a complete Sinatra application for testing and development:
+
+```ruby
+require 'maplibre-preview'
+
+# Run standalone development server
+MapLibrePreview::App.run!
+```
+
+This starts a complete web server with:
+- Map interface at `http://localhost:4567/map`
+- JavaScript assets served from `/js/*`
+- All gem functionality available out of the box
+
+**How to use with a style:**
+- Pass style URL as parameter: `http://localhost:4567/map?style_url=https://example.com/style.json`
+
+**Without a style:**
+- Shows only basemap tiles (OpenStreetMap)
+- Useful for testing basic functionality
+- No custom layers or styling
+
+**Use cases:**
+- Quick testing of gem functionality
+- Development and debugging
+- Demonstrating capabilities
+
+## Configuration
+
+The gem uses fixed configurations for optimal compatibility:
+
+- **Map Center**: `[35.15, 47.41]`
+- **Initial Zoom**: `2`
+- **Basemap**: OpenStreetMap tiles with 0.8 opacity
+- **Library Versions**: MapLibre GL JS 5.7.3, MapLibre Contour 0.1.0, D3.js 7
+
+**Style URL**: Pass via URL parameter `?style_url=https://example.com/style.json`
+
+## API Reference
+
+### Sinatra Extension
+
+```ruby
+# Register the extension
+register MapLibrePreview::Extension
+```
+
+### Template Integration
+
+The gem provides Slim templates that can be used directly in your routes:
+
+| Template | Description | Usage |
+|----------|-------------|-------|
+| `maplibre_map` | Main map interface template | `slim :maplibre_map, layout: :maplibre_layout` |
+| `maplibre_layout` | HTML layout with external dependencies | Used as layout for map template |
+
+### Standalone Application
+
+```ruby
+# Available routes
+GET /map          # Main map development interface
+GET /js/:file     # JavaScript asset serving
+```
+
+## Style Metadata Support
+
+The gem supports advanced filtering through style metadata:
+
+```json
+{
+  "metadata": {
+    "filters": {
+      "buildings": [
+        {
+          "id": "residential",
+          "filter": ["==", ["get", "type"], "residential"]
+        },
+        {
+          "id": "commercial", 
+          "filter": ["==", ["get", "type"], "commercial"]
+        }
+      ]
+    },
+    "locale": {
+      "en": {
+        "buildings": "Buildings",
+        "residential": "Residential",
+        "commercial": "Commercial"
+      }
+    }
+  }
+}
+```
+
+## Terrain Support
+
+For terrain visualization, add terrain configuration to your style:
+
+```json
+{
+  "terrain": {
+    "source": "terrain-source"
+  },
+  "sources": {
+    "terrain-source": {
+      "type": "raster-dem",
+      "tiles": ["https://your-terrain-tiles/{z}/{x}/{y}.png"],
+      "encoding": "terrarium"
+    }
+  }
+}
+```
+
+## Performance Monitoring
+
+The gem includes real-time performance monitoring:
+
+- **FPS and Frame Time**: Real-time rendering performance
+- **Memory Usage**: JavaScript heap memory monitoring
+- **Tile Loading**: Active tile count and loading status
+- **Layer Management**: Active layer count and visibility
+- **Zoom Level**: Current map zoom level
+- **Terrain Status**: Terrain data availability
+
+## File Structure
+
+```
+lib/
+├── maplibre-preview.rb          # Main gem module and Sinatra integration
+└── maplibre-preview/
+    ├── version.rb                # Gem version
+    ├── views/                    # Slim templates
+    │   ├── map.slim             # Main map interface
+    │   └── map_layout.slim      # HTML layout
+    └── public/js/               # JavaScript modules
+        ├── filters.js           # Layer filtering logic
+        └── contour.js           # Terrain and contour features
+```
+
+## Development
+
+### Prerequisites
+
+- Ruby 2.7+
+- Sinatra 2.1+
+- Slim 4.1+
+- Rack 2.0+
+
+### Setup
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests
+bundle exec rspec
+
+# Run RuboCop
+bundle exec rubocop
+
+# Build gem
+gem build maplibre-preview.gemspec
+```
+
+### Testing
+
+```bash
+# Run all tests
+bundle exec rspec
+
+# Run specific test file
+bundle exec rspec spec/maplibre_preview_spec.rb
+```
+
+## Integration Examples
+
+### Basic Map Integration
+
+```ruby
+class MyApp < Sinatra::Base
+  register MapLibrePreview::Extension
+  
+  get '/map' do
+    slim :maplibre_map, layout: :maplibre_layout
+  end
+end
+```
+
+### Style URL Integration
+
+```ruby
+class MyApp < Sinatra::Base
+  register MapLibrePreview::Extension
+  
+  get '/map' do
+    # Style URL passed via params[:style_url]
+    slim :maplibre_map, layout: :maplibre_layout
+  end
+end
+```
+
+### Multiple Map Routes
+
+```ruby
+class MyApp < Sinatra::Base
+  register MapLibrePreview::Extension
+  
+  get '/map' do
+    # Uses params[:style_url] if provided
+    slim :maplibre_map, layout: :maplibre_layout
+  end
+  
+  get '/terrain' do
+    # Set style URL via params
+    params[:style_url] = 'https://example.com/terrain-style.json'
+    slim :maplibre_map, layout: :maplibre_layout
+  end
+end
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.