#22 literal indexes increasing when reload

Author: arthurmeijer

CHANGELOG.txt

@@ -1,3 +1,6 @@
+1.2.11 - 12 July 2019
+- #22 literal indexes increasing when reload
+
 1.2.10 - 8 July 2019
 - Updated to browscap 6000034 
 - Updated unit tests accordingly
@@ -43,7 +46,7 @@
   Performance updates for memory footprint and startup time.
 
 1.1.0 - 24 Nov 2017
-  Intregrated PR 2; the browscap fields are now configurable in the constructor of the parser.
+  Integrated PR 2; the browscap fields are now configurable in the constructor of the parser.
   Updated documentation and unit tests.
 
 1.0.4 - 5 Oct 2017

README.md

@@ -42,7 +42,7 @@ Add this to the dependencies in your pom.xml.
 <dependency>
   <groupId>com.blueconic</groupId>
   <artifactId>browscap-java</artifactId>
-  <version>1.2.10</version>
+  <version>1.2.11</version>
 </dependency>
 ```
 

pom.xml

@@ -4,7 +4,7 @@
     <groupId>com.blueconic</groupId>
     <artifactId>browscap-java</artifactId>
     <packaging>jar</packaging>
-    <version>1.2.10</version>
+    <version>1.2.11</version>
     <name>browscap-java</name>
     <description>A blazingly fast and memory efficient Java client on top of the BrowsCap CSV source files.</description>
 

src/main/java/com/blueconic/browscap/impl/SearchableString.java

@@ -23,11 +23,11 @@ class SearchableString {
     /**
      * Creates a new instance for the specified string value.
      * @param stringValue The user agent string
+     * @param maxIndex The number of unique literals
      */
-    SearchableString(final String stringValue) {
+    SearchableString(final String stringValue, final int maxIndex) {
         myChars = stringValue.toCharArray();
-        final int max = Literal.getNumberOfInstances() + 1;
-        myIndices = new int[max][];
+        myIndices = new int[maxIndex][];
         myBuffer = new int[myChars.length];
     }
 
@@ -206,9 +206,6 @@ void set(final int index, final boolean flag) {
  */
 class Literal {
 
-    // Keep track of the total number of instances
-    private static final AtomicInteger NUMBER_OF_INSTANCES = new AtomicInteger();
-
     // The actual string data
     private final char[] myCharacters;
 
@@ -218,10 +215,11 @@ class Literal {
     /**
      * Creates a new instance with the specified non-empty value.
      * @param value The String value
+     * @param index The unique index for this instance
      */
-    Literal(final String value) {
+    Literal(final String value, final int index) {
         myCharacters = value.toCharArray();
-        myIndex = NUMBER_OF_INSTANCES.getAndAdd(1);
+        myIndex = index;
     }
 
     /**
@@ -273,14 +271,6 @@ final int getIndex() {
         return myIndex;
     }
 
-    /**
-     * Returns the total number of literals.
-     * @return the total number of literals.
-     */
-    static int getNumberOfInstances() {
-        return NUMBER_OF_INSTANCES.get();
-    }
-
     private static boolean contains(final char[] characters, final char value) {
 
         for (final char c : characters) {
@@ -312,3 +302,19 @@ public String toString() {
         return new String(myCharacters);
     }
 }
+
+class LiteralDomain {
+
+    // Keep track of the total number of instances
+    private final AtomicInteger myNrOfInstances = new AtomicInteger();
+
+    Literal createLiteral(final String contents) {
+        return new Literal(contents, myNrOfInstances.getAndAdd(1));
+    }
+
+    SearchableString getSearchableString(final String contents) {
+        final int maxIndex = myNrOfInstances.get() + 1;
+
+        return new SearchableString(contents, maxIndex);
+    }
+}

src/main/java/com/blueconic/browscap/impl/UserAgentFileParser.java

@@ -40,6 +40,8 @@ public class UserAgentFileParser {
 
     private final Set<BrowsCapField> myFields;
 
+    private final LiteralDomain myDomain = new LiteralDomain();
+
     UserAgentFileParser(final Collection<BrowsCapField> fields) {
         myFields = new HashSet<>(fields);
         myMapper = new Mapper(myFields);
@@ -70,7 +72,7 @@ private UserAgentParser parse(final Reader input) throws IOException, ParseExcep
                 }
             }
         }
-        return new UserAgentParserImpl(rules.toArray(new Rule[0]), getDefaultCapabilities());
+        return new UserAgentParserImpl(rules.toArray(new Rule[0]), myDomain, getDefaultCapabilities());
     }
 
     Capabilities getDefaultCapabilities() {
@@ -152,7 +154,11 @@ Capabilities getCapabilities(final Map<BrowsCapField, String> values) {
     }
 
     Literal getLiteral(final String value) {
-        return myUniqueLiterals.computeIfAbsent(value, Literal::new);
+        return myUniqueLiterals.computeIfAbsent(value, myDomain::createLiteral);
+    }
+
+    LiteralDomain getDomain() {
+        return myDomain;
     }
 
     Rule createRule(final String pattern, final Capabilities capabilities) {

src/main/java/com/blueconic/browscap/impl/UserAgentParserImpl.java

@@ -43,11 +43,17 @@ class UserAgentParserImpl implements UserAgentParser {
     // The default Capabilities
     private final Capabilities myDefaultCapabilities;
 
+    // The domain of literals for this parser
+    private final LiteralDomain myDomain;
+
     /**
      * Creates a new parser based on a collection of rules.
      * @param rules The rules, ordered by priority
+     * @param domain The domain of literals
+     * @param defaultCapabilities The default capabilities
      */
-    UserAgentParserImpl(final Rule[] rules, final Capabilities defaultCapabilities) {
+    UserAgentParserImpl(final Rule[] rules, final LiteralDomain domain, final Capabilities defaultCapabilities) {
+        myDomain = domain;
         myRules = getOrderedRules(rules);
         myFilters = buildFilters();
         myDefaultCapabilities = defaultCapabilities;
@@ -59,7 +65,7 @@ class UserAgentParserImpl implements UserAgentParser {
     @Override
     public Capabilities parse(final String userAgent) {
 
-        final SearchableString searchString = new SearchableString(userAgent.toLowerCase());
+        final SearchableString searchString = myDomain.getSearchableString(userAgent.toLowerCase());
 
         final BitSet includes = getIncludeRules(searchString, myFilters);
 
@@ -113,7 +119,7 @@ Filter[] buildFilters() {
     }
 
     Filter createContainsFilter(final String pattern) {
-        final Literal literal = new Literal(pattern);
+        final Literal literal = myDomain.createLiteral(pattern);
 
         final Predicate<SearchableString> pred = c -> c.getIndices(literal).length > 0;
 
@@ -123,7 +129,7 @@ Filter createContainsFilter(final String pattern) {
     }
 
     Filter createPrefixFilter(final String pattern) {
-        final Literal literal = new Literal(pattern);
+        final Literal literal = myDomain.createLiteral(pattern);
 
         final Predicate<SearchableString> pred = s -> s.startsWith(literal);
 

src/test/java/com/blueconic/browscap/impl/RuleTest.java

@@ -7,10 +7,18 @@
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
+import org.junit.Before;
 import org.junit.Test;
 
 public class RuleTest {
 
+    private UserAgentFileParser myParser;
+
+    @Before
+    public void setup() {
+        myParser = new UserAgentFileParser(singleton(BROWSER));
+    }
+
     @Test
     public void testLiteralExpression() {
         final Rule rule = getRule("a");
@@ -131,13 +139,13 @@ public void testRequires() {
     }
 
     private Rule getRule(final String pattern) {
-        final UserAgentFileParser parser = new UserAgentFileParser(singleton(BROWSER));
-        final Rule rule = parser.createRule(pattern, DEFAULT);
+        final Rule rule = myParser.createRule(pattern, DEFAULT);
         assertEquals(pattern, rule.getPattern());
         return rule;
     }
 
     private boolean matches(final Rule rule, final String useragent) {
-        return rule.matches(new SearchableString(useragent));
+        final SearchableString searchableString = myParser.getDomain().getSearchableString(useragent);
+        return rule.matches(searchableString);
     }
 }

src/test/java/com/blueconic/browscap/impl/SearchableStringTest.java

@@ -15,11 +15,14 @@ public class SearchableStringTest {
 
     @Test
     public void testSearchableString() {
-        final Literal abc = new Literal("abc");
-        final Literal ab = new Literal("ab");
+
+        final LiteralDomain domain = new LiteralDomain();
+
+        final Literal abc = domain.createLiteral("abc");
+        final Literal ab = domain.createLiteral("ab");
 
         final String stringValue = "abababc";
-        final SearchableString cache = new SearchableString(stringValue);
+        final SearchableString cache = domain.getSearchableString(stringValue);
 
         assertTrue(cache.startsWith(ab));
         assertFalse(cache.startsWith(abc));
@@ -38,12 +41,14 @@ public void testSearchableString() {
 
     @Test
     public void testGetIndices() {
-        final Literal abc = new Literal("abc");
-        final Literal ab = new Literal("ab");
-        final Literal anyChar = new Literal("?ab");
-        final Literal noMatch = new Literal("aaaaaaaaaaaaaaaaaa");
+        final LiteralDomain domain = new LiteralDomain();
 
-        final SearchableString cache = new SearchableString("abababc");
+        final Literal abc = domain.createLiteral("abc");
+        final Literal ab = domain.createLiteral("ab");
+        final Literal anyChar = domain.createLiteral("?ab");
+        final Literal noMatch = domain.createLiteral("aaaaaaaaaaaaaaaaaa");
+
+        final SearchableString cache = domain.getSearchableString("abababc");
 
         assertArrayEquals(new int[]{4}, cache.getIndices(abc));
         assertArrayEquals(new int[]{0, 2, 4}, cache.getIndices(ab));
@@ -72,17 +77,23 @@ public void testCache() {
 
     @Test
     public void testLiteralBasics() {
+
+        final LiteralDomain domain = new LiteralDomain();
+
         final String input = "abcdef";
-        final Literal literal = new Literal(input);
+        final Literal literal = domain.createLiteral(input);
         assertEquals(input.length(), literal.getLength());
         assertEquals('a', literal.getFirstChar());
         assertEquals(input, literal.toString());
     }
 
     @Test
     public void testLiteralMatches() {
+
+        final LiteralDomain domain = new LiteralDomain();
+
         final String input = "def";
-        final Literal literal = new Literal(input);
+        final Literal literal = domain.createLiteral(input);
 
         // Test for matches also with invalid bounds
         final char[] search = "abcdef".toCharArray();
@@ -92,7 +103,7 @@ public void testLiteralMatches() {
         assertFalse(literal.matches(search, -10));
         assertFalse(literal.matches(search, 100));
 
-        final Literal joker = new Literal("d?f");
+        final Literal joker = domain.createLiteral("d?f");
         assertTrue(joker.matches(search, 3));
         assertFalse(literal.matches(search, 0));
         assertFalse(literal.matches(search, 5));

src/test/java/com/blueconic/browscap/impl/UserAgentParserTest.java

@@ -19,12 +19,20 @@
 
 import java.util.BitSet;
 
+import org.junit.Before;
 import org.junit.Test;
 
 import com.blueconic.browscap.impl.UserAgentParserImpl.Filter;
 
 public class UserAgentParserTest {
 
+    private UserAgentFileParser myParser;
+
+    @Before
+    public void setup() {
+        myParser = new UserAgentFileParser(singleton(BROWSER));
+    }
+
     @Test
     public void testExcludes() {
 
@@ -64,22 +72,23 @@ public void testGetIncludes() {
         final Rule d = getRule("*123*");
         final Rule[] rules = {a, b, c, d};
 
-        final UserAgentParserImpl parser = new UserAgentParserImpl(rules, DEFAULT);
+        final LiteralDomain domain = myParser.getDomain();
+        final UserAgentParserImpl parser = new UserAgentParserImpl(rules, domain, DEFAULT);
 
         final Filter startsWithTest = parser.createPrefixFilter("test");
         final Filter containsTest = parser.createContainsFilter("test");
         final Filter containsNumbers = parser.createContainsFilter("123");
         final Filter[] filters = {startsWithTest, containsTest, containsNumbers};
 
-        final SearchableString useragent = new SearchableString("useragent_test_string");
+        final SearchableString useragent = domain.getSearchableString("useragent_test_string");
         final BitSet includeRules = parser.getIncludeRules(useragent, filters);
 
         // b should be checked
         assertEquals(1, includeRules.nextSetBit(0));
         // No further rules to check
         assertEquals(-1, includeRules.nextSetBit(2));
 
-        final SearchableString numberString = new SearchableString("123456");
+        final SearchableString numberString = domain.getSearchableString("123456");
         final BitSet numberIncludes = parser.getIncludeRules(numberString, filters);
 
         // Only d should be checked
@@ -106,8 +115,7 @@ public void testGetOrderedRules() {
     }
 
     private Rule getRule(final String pattern) {
-        final UserAgentFileParser parser = new UserAgentFileParser(singleton(BROWSER));
-        final Rule rule = parser.createRule(pattern, DEFAULT);
+        final Rule rule = myParser.createRule(pattern, DEFAULT);
         assertEquals(pattern, rule.getPattern());
         return rule;
     }